mei_dev.h 10.7 KB
Newer Older
1 2 3
/*
 *
 * Intel Management Engine Interface (Intel MEI) Linux driver
4
 * Copyright (c) 2003-2012, Intel Corporation.
5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms and conditions of the GNU General Public License,
 * version 2, as published by the Free Software Foundation.
 *
 * This program is distributed in the hope it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
 * more details.
 *
 */

#ifndef _MEI_DEV_H_
#define _MEI_DEV_H_

#include <linux/types.h>
21
#include <linux/watchdog.h>
22
#include <linux/mei.h>
23 24 25 26 27
#include "hw.h"

/*
 * watch dog definition
 */
28 29 30 31 32 33 34 35
#define MEI_WD_HDR_SIZE       4
#define MEI_WD_STOP_MSG_SIZE  MEI_WD_HDR_SIZE
#define MEI_WD_START_MSG_SIZE (MEI_WD_HDR_SIZE + 16)

#define MEI_WD_DEFAULT_TIMEOUT   120  /* seconds */
#define MEI_WD_MIN_TIMEOUT       120  /* seconds */
#define MEI_WD_MAX_TIMEOUT     65535  /* seconds */

36 37
#define MEI_WD_STOP_TIMEOUT      10 /* msecs */

38 39
#define MEI_WD_STATE_INDEPENDENCE_MSG_SENT       (1 << 0)

40 41
#define MEI_RD_MSG_BUF_SIZE           (128 * sizeof(u32))

42

43 44 45 46 47 48 49 50 51 52 53 54 55 56 57
/*
 * AMTHI Client UUID
 */
extern const uuid_le mei_amthi_guid;

/*
 * Watchdog Client UUID
 */
extern const uuid_le mei_wd_guid;

/*
 * Watchdog independence state message
 */
extern const u8 mei_wd_state_independence_msg[3][4];

58 59 60 61 62
/*
 * Number of Maximum MEI Clients
 */
#define MEI_CLIENTS_MAX 256

63 64 65 66
/*
 * Number of File descriptors/handles
 * that can be opened to the driver.
 *
67 68
 * Limit to 253: 256 Total Clients
 * minus internal client for MEI Bus Messags
69 70 71
 * minus internal client for AMTHI
 * minus internal client for Watchdog
 */
72
#define  MEI_MAX_OPEN_HANDLE_COUNT (MEI_CLIENTS_MAX - 3)
73 74 75 76 77 78 79 80 81 82 83 84


/* File state */
enum file_state {
	MEI_FILE_INITIALIZING = 0,
	MEI_FILE_CONNECTING,
	MEI_FILE_CONNECTED,
	MEI_FILE_DISCONNECTING,
	MEI_FILE_DISCONNECTED
};

/* MEI device states */
85 86 87 88 89 90 91 92 93
enum mei_dev_state {
	MEI_DEV_INITIALIZING = 0,
	MEI_DEV_INIT_CLIENTS,
	MEI_DEV_ENABLED,
	MEI_DEV_RESETING,
	MEI_DEV_DISABLED,
	MEI_DEV_RECOVERING_FROM_RESET,
	MEI_DEV_POWER_DOWN,
	MEI_DEV_POWER_UP
94 95
};

96 97
const char *mei_dev_state_str(int state);

98
/* init clients states*/
99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121
enum mei_init_clients_states {
	MEI_START_MESSAGE = 0,
	MEI_ENUM_CLIENTS_MESSAGE,
	MEI_CLIENT_PROPERTIES_MESSAGE
};

enum iamthif_states {
	MEI_IAMTHIF_IDLE,
	MEI_IAMTHIF_WRITING,
	MEI_IAMTHIF_FLOW_CONTROL,
	MEI_IAMTHIF_READING,
	MEI_IAMTHIF_READ_COMPLETE
};

enum mei_file_transaction_states {
	MEI_IDLE,
	MEI_WRITING,
	MEI_WRITE_COMPLETE,
	MEI_FLOW_CONTROL,
	MEI_READING,
	MEI_READ_COMPLETE
};

122 123 124 125 126 127
enum mei_wd_states {
	MEI_WD_IDLE,
	MEI_WD_RUNNING,
	MEI_WD_STOPPING,
};

128 129 130 131 132 133 134 135 136 137 138 139 140 141
/* MEI CB */
enum mei_cb_major_types {
	MEI_READ = 0,
	MEI_WRITE,
	MEI_IOCTL,
	MEI_OPEN,
	MEI_CLOSE
};

/*
 * Intel MEI message data struct
 */
struct mei_message_data {
	u32 size;
142
	unsigned char *data;
143
};
144 145 146


struct mei_cl_cb {
147
	struct list_head list;
148 149 150 151
	enum mei_cb_major_types major_file_operations;
	void *file_private;
	struct mei_message_data request_buffer;
	struct mei_message_data response_buffer;
152
	unsigned long buf_idx;
153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177
	unsigned long read_time;
	struct file *file_object;
};

/* MEI client instance carried as file->pirvate_data*/
struct mei_cl {
	struct list_head link;
	struct mei_device *dev;
	enum file_state state;
	wait_queue_head_t tx_wait;
	wait_queue_head_t rx_wait;
	wait_queue_head_t wait;
	int read_pending;
	int status;
	/* ID of client connected */
	u8 host_client_id;
	u8 me_client_id;
	u8 mei_flow_ctrl_creds;
	u8 timer_count;
	enum mei_file_transaction_states reading_state;
	enum mei_file_transaction_states writing_state;
	int sm_state;
	struct mei_cl_cb *read_cb;
};

178 179 180 181
/**
 * struct mei_deive -  MEI private device struct
 * @hbuf_depth - depth of host(write) buffer
 */
182 183 184 185 186 187
struct mei_device {
	struct pci_dev *pdev;	/* pointer to pci device struct */
	/*
	 * lists of queues
	 */
	 /* array of pointers to aio lists */
188 189 190 191 192 193
	struct mei_cl_cb read_list;		/* driver read queue */
	struct mei_cl_cb write_list;		/* driver write queue */
	struct mei_cl_cb write_waiting_list;	/* write waiting queue */
	struct mei_cl_cb ctrl_wr_list;		/* managed write IOCTL list */
	struct mei_cl_cb ctrl_rd_list;		/* managed read IOCTL list */
	struct mei_cl_cb amthi_cmd_list;	/* amthi list for cmd waiting */
194 195

	/* driver managed amthi list for reading completed amthi cmd data */
196
	struct mei_cl_cb amthi_read_complete_list;
197 198 199 200
	/*
	 * list of files
	 */
	struct list_head file_list;
201
	long open_handle_count;
202 203 204 205 206 207 208 209 210 211
	/*
	 * memory of device
	 */
	unsigned int mem_base;
	unsigned int mem_length;
	void __iomem *mem_addr;
	/*
	 * lock for the device
	 */
	struct mutex device_lock; /* device lock */
212
	struct delayed_work timer_work;	/* MEI timer delayed work (timeouts) */
213
	bool recvd_msg;
214 215 216 217 218
	/*
	 * hw states of host and fw(ME)
	 */
	u32 host_hw_state;
	u32 me_hw_state;
219
	u8  hbuf_depth;
220 221 222 223 224 225 226 227 228
	/*
	 * waiting queue for receive message from FW
	 */
	wait_queue_head_t wait_recvd_msg;
	wait_queue_head_t wait_stop_wd;

	/*
	 * mei device  states
	 */
229
	enum mei_dev_state dev_state;
230 231
	enum mei_init_clients_states init_clients_state;
	u16 init_clients_timer;
232
	bool need_reset;
233 234

	u32 extra_write_index;
235
	unsigned char rd_msg_buf[MEI_RD_MSG_BUF_SIZE];	/* control messages */
236 237 238 239 240 241 242 243 244
	u32 wr_msg_buf[128];	/* used for control messages */
	u32 ext_msg_buf[8];	/* for control responses */
	u32 rd_msg_hdr;

	struct hbm_version version;

	struct mei_me_client *me_clients; /* Note: memory has to be allocated */
	DECLARE_BITMAP(me_clients_map, MEI_CLIENTS_MAX);
	DECLARE_BITMAP(host_clients_map, MEI_CLIENTS_MAX);
245
	u8 me_clients_num;
246 247
	u8 me_client_presentation_num;
	u8 me_client_index;
248
	bool mei_host_buffer_is_empty;
249

250
	struct mei_cl wd_cl;
251
	enum mei_wd_states wd_state;
252
	bool wd_interface_reg;
253
	bool wd_pending;
254
	u16 wd_timeout;
255
	unsigned char wd_data[MEI_WD_START_MSG_SIZE];
256 257 258 259


	struct file *iamthif_file_object;
	struct mei_cl iamthif_cl;
260
	struct mei_cl_cb *iamthif_current_cb;
261 262 263 264 265 266 267
	int iamthif_mtu;
	unsigned long iamthif_timer;
	u32 iamthif_stall_timer;
	unsigned char *iamthif_msg_buf; /* Note: memory has to be allocated */
	u32 iamthif_msg_buf_size;
	u32 iamthif_msg_buf_index;
	enum iamthif_states iamthif_state;
268 269 270
	bool iamthif_flow_control_pending;
	bool iamthif_ioctl;
	bool iamthif_canceled;
271 272
};

273 274 275 276 277
static inline unsigned long mei_secs_to_jiffies(unsigned long sec)
{
	return msecs_to_jiffies(sec * MSEC_PER_SEC);
}

278 279 280 281

/*
 * mei init function prototypes
 */
282
struct mei_device *mei_device_init(struct pci_dev *pdev);
283 284 285 286 287
void mei_reset(struct mei_device *dev, int interrupts);
int mei_hw_init(struct mei_device *dev);
int mei_task_initialize_clients(void *data);
int mei_initialize_clients(struct mei_device *dev);
int mei_disconnect_host_client(struct mei_device *dev, struct mei_cl *cl);
288
void mei_remove_client_from_file_list(struct mei_device *dev, u8 host_client_id);
289 290
void mei_host_init_iamthif(struct mei_device *dev);
void mei_allocate_me_clients_storage(struct mei_device *dev);
291 292


293 294 295 296
int mei_me_cl_update_filext(struct mei_device *dev, struct mei_cl *cl,
			const uuid_le *cguid, u8 host_client_id);
int mei_me_cl_by_uuid(const struct mei_device *dev, const uuid_le *cuuid);
int mei_me_cl_by_id(struct mei_device *dev, u8 client_id);
297

298
/*
299
 * MEI IO Functions
300
 */
301
struct mei_cl_cb *mei_io_cb_init(struct mei_cl *cl, struct file *fp);
302
void mei_io_cb_free(struct mei_cl_cb *priv_cb);
303 304 305
int mei_io_cb_alloc_req_buf(struct mei_cl_cb *cb, size_t length);
int mei_io_cb_alloc_resp_buf(struct mei_cl_cb *cb, size_t length);

306

307 308 309 310 311 312 313 314 315 316
/**
 * mei_io_list_init - Sets up a queue list.
 *
 * @list: An instance cl callback structure
 */
static inline void mei_io_list_init(struct mei_cl_cb *list)
{
	INIT_LIST_HEAD(&list->list);
}
void mei_io_list_flush(struct mei_cl_cb *list, struct mei_cl *cl);
317

318
/*
319 320 321 322
 * MEI ME Client Functions
 */

struct mei_cl *mei_cl_allocate(struct mei_device *dev);
323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340
void mei_cl_init(struct mei_cl *cl, struct mei_device *dev);
int mei_cl_flush_queues(struct mei_cl *cl);
/**
 * mei_cl_cmp_id - tells if file private data have same id
 *
 * @fe1: private data of 1. file object
 * @fe2: private data of 2. file object
 *
 * returns true  - if ids are the same and not NULL
 */
static inline bool mei_cl_cmp_id(const struct mei_cl *cl1,
				const struct mei_cl *cl2)
{
	return cl1 && cl2 &&
		(cl1->host_client_id == cl2->host_client_id) &&
		(cl1->me_client_id == cl2->me_client_id);
}

341 342 343 344 345 346 347


/*
 * MEI Host Client Functions
 */
void mei_host_start_message(struct mei_device *dev);
void mei_host_enum_clients_message(struct mei_device *dev);
348
int mei_host_client_properties(struct mei_device *dev);
349 350 351

/*
 *  MEI interrupt functions prototype
352 353
 */
irqreturn_t mei_interrupt_quick_handler(int irq, void *dev_id);
354
irqreturn_t mei_interrupt_thread_handler(int irq, void *dev_id);
355
void mei_timer(struct work_struct *work);
356 357

/*
358
 *  MEI input output function prototype
359 360 361 362 363 364 365 366 367 368 369 370 371 372
 */
int mei_ioctl_connect_client(struct file *file,
			struct mei_connect_client_data *data);

int mei_start_read(struct mei_device *dev, struct mei_cl *cl);

int amthi_write(struct mei_device *dev, struct mei_cl_cb *priv_cb);

int amthi_read(struct mei_device *dev, struct file *file,
	      char __user *ubuf, size_t length, loff_t *offset);

struct mei_cl_cb *find_amthi_read_list_entry(struct mei_device *dev,
						struct file *file);

373
void mei_run_next_iamthif_cmd(struct mei_device *dev);
374 375 376 377 378 379 380 381 382 383 384 385 386



/*
 * Register Access Function
 */

/**
 * mei_reg_read - Reads 32bit data from the mei device
 *
 * @dev: the device structure
 * @offset: offset from which to read the data
 *
387
 * returns register value (u32)
388
 */
389 390
static inline u32 mei_reg_read(const struct mei_device *dev,
			       unsigned long offset)
391 392 393 394 395 396 397 398 399
{
	return ioread32(dev->mem_addr + offset);
}

/**
 * mei_reg_write - Writes 32bit data to the mei device
 *
 * @dev: the device structure
 * @offset: offset from which to write the data
400
 * @value: register value to write (u32)
401
 */
402 403
static inline void mei_reg_write(const struct mei_device *dev,
				 unsigned long offset, u32 value)
404 405 406 407 408 409 410 411 412 413 414
{
	iowrite32(value, dev->mem_addr + offset);
}

/**
 * mei_hcsr_read - Reads 32bit data from the host CSR
 *
 * @dev: the device structure
 *
 * returns the byte read.
 */
415
static inline u32 mei_hcsr_read(const struct mei_device *dev)
416 417 418 419 420 421 422 423 424 425 426
{
	return mei_reg_read(dev, H_CSR);
}

/**
 * mei_mecsr_read - Reads 32bit data from the ME CSR
 *
 * @dev: the device structure
 *
 * returns ME_CSR_HA register value (u32)
 */
427
static inline u32 mei_mecsr_read(const struct mei_device *dev)
428 429 430 431 432 433 434 435 436 437 438
{
	return mei_reg_read(dev, ME_CSR_HA);
}

/**
 * get_me_cb_rw - Reads 32bit data from the mei ME_CB_RW register
 *
 * @dev: the device structure
 *
 * returns ME_CB_RW register value (u32)
 */
439
static inline u32 mei_mecbrw_read(const struct mei_device *dev)
440 441 442 443 444 445 446 447 448 449 450 451 452 453 454
{
	return mei_reg_read(dev, ME_CB_RW);
}


/*
 * mei interface function prototypes
 */
void mei_hcsr_set(struct mei_device *dev);
void mei_csr_clear_his(struct mei_device *dev);

void mei_enable_interrupts(struct mei_device *dev);
void mei_disable_interrupts(struct mei_device *dev);

#endif