Oren Weil | ab84116 | 2011-05-15 13:43:41 +0300 | [diff] [blame] | 1 | /* |
| 2 | * |
| 3 | * Intel Management Engine Interface (Intel MEI) Linux driver |
Tomas Winkler | 733ba91 | 2012-02-09 19:25:53 +0200 | [diff] [blame] | 4 | * Copyright (c) 2003-2012, Intel Corporation. |
Oren Weil | ab84116 | 2011-05-15 13:43:41 +0300 | [diff] [blame] | 5 | * |
| 6 | * This program is free software; you can redistribute it and/or modify it |
| 7 | * under the terms and conditions of the GNU General Public License, |
| 8 | * version 2, as published by the Free Software Foundation. |
| 9 | * |
| 10 | * This program is distributed in the hope it will be useful, but WITHOUT |
| 11 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
| 12 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for |
| 13 | * more details. |
| 14 | * |
| 15 | */ |
| 16 | |
| 17 | #ifndef _MEI_DEV_H_ |
| 18 | #define _MEI_DEV_H_ |
| 19 | |
| 20 | #include <linux/types.h> |
Oren Weil | 9ce178e | 2011-09-07 09:03:09 +0300 | [diff] [blame] | 21 | #include <linux/watchdog.h> |
Tomas Winkler | 744f0f2 | 2012-11-11 17:38:02 +0200 | [diff] [blame] | 22 | #include <linux/poll.h> |
Tomas Winkler | 4f3afe1 | 2012-05-09 16:38:59 +0300 | [diff] [blame] | 23 | #include <linux/mei.h> |
Samuel Ortiz | e535410 | 2013-03-27 17:29:53 +0200 | [diff] [blame] | 24 | #include <linux/mei_cl_bus.h> |
Tomas Winkler | 66ef5ea | 2012-12-25 19:06:02 +0200 | [diff] [blame] | 25 | |
Oren Weil | ab84116 | 2011-05-15 13:43:41 +0300 | [diff] [blame] | 26 | #include "hw.h" |
Tomas Winkler | 9b0d5ef | 2013-04-18 23:03:48 +0300 | [diff] [blame] | 27 | #include "hbm.h" |
Oren Weil | ab84116 | 2011-05-15 13:43:41 +0300 | [diff] [blame] | 28 | |
| 29 | /* |
Oren Weil | ab84116 | 2011-05-15 13:43:41 +0300 | [diff] [blame] | 30 | * watch dog definition |
| 31 | */ |
Tomas Winkler | 248ffdf | 2012-08-16 19:39:42 +0300 | [diff] [blame] | 32 | #define MEI_WD_HDR_SIZE 4 |
| 33 | #define MEI_WD_STOP_MSG_SIZE MEI_WD_HDR_SIZE |
| 34 | #define MEI_WD_START_MSG_SIZE (MEI_WD_HDR_SIZE + 16) |
| 35 | |
| 36 | #define MEI_WD_DEFAULT_TIMEOUT 120 /* seconds */ |
| 37 | #define MEI_WD_MIN_TIMEOUT 120 /* seconds */ |
| 38 | #define MEI_WD_MAX_TIMEOUT 65535 /* seconds */ |
| 39 | |
Tomas Winkler | c216fde | 2012-08-16 19:39:43 +0300 | [diff] [blame] | 40 | #define MEI_WD_STOP_TIMEOUT 10 /* msecs */ |
| 41 | |
Oren Weil | ab84116 | 2011-05-15 13:43:41 +0300 | [diff] [blame] | 42 | #define MEI_WD_STATE_INDEPENDENCE_MSG_SENT (1 << 0) |
| 43 | |
Tomas Winkler | edf1eed | 2012-02-09 19:25:54 +0200 | [diff] [blame] | 44 | #define MEI_RD_MSG_BUF_SIZE (128 * sizeof(u32)) |
| 45 | |
Oren Weil | 9ce178e | 2011-09-07 09:03:09 +0300 | [diff] [blame] | 46 | |
| 47 | /* |
Oren Weil | ab84116 | 2011-05-15 13:43:41 +0300 | [diff] [blame] | 48 | * AMTHI Client UUID |
| 49 | */ |
Tomas Winkler | 1a1aca4 | 2013-01-08 23:07:21 +0200 | [diff] [blame] | 50 | extern const uuid_le mei_amthif_guid; |
Oren Weil | ab84116 | 2011-05-15 13:43:41 +0300 | [diff] [blame] | 51 | |
| 52 | /* |
| 53 | * Watchdog Client UUID |
| 54 | */ |
| 55 | extern const uuid_le mei_wd_guid; |
| 56 | |
| 57 | /* |
Tomas Winkler | 1e2776c | 2012-08-24 00:35:58 +0300 | [diff] [blame] | 58 | * Number of Maximum MEI Clients |
| 59 | */ |
| 60 | #define MEI_CLIENTS_MAX 256 |
| 61 | |
| 62 | /* |
Tomas Winkler | 6adb8ef | 2014-01-12 00:36:10 +0200 | [diff] [blame] | 63 | * maximum number of consecutive resets |
| 64 | */ |
| 65 | #define MEI_MAX_CONSEC_RESET 3 |
| 66 | |
| 67 | /* |
Oren Weil | ab84116 | 2011-05-15 13:43:41 +0300 | [diff] [blame] | 68 | * Number of File descriptors/handles |
| 69 | * that can be opened to the driver. |
| 70 | * |
Tomas Winkler | 781d0d8 | 2013-01-08 23:07:22 +0200 | [diff] [blame] | 71 | * Limit to 255: 256 Total Clients |
Alexander Usyskin | 83ce074 | 2014-01-08 22:31:46 +0200 | [diff] [blame] | 72 | * minus internal client for MEI Bus Messages |
Oren Weil | ab84116 | 2011-05-15 13:43:41 +0300 | [diff] [blame] | 73 | */ |
Tomas Winkler | 781d0d8 | 2013-01-08 23:07:22 +0200 | [diff] [blame] | 74 | #define MEI_MAX_OPEN_HANDLE_COUNT (MEI_CLIENTS_MAX - 1) |
Oren Weil | ab84116 | 2011-05-15 13:43:41 +0300 | [diff] [blame] | 75 | |
Tomas Winkler | 1d3f3da | 2012-12-25 19:06:01 +0200 | [diff] [blame] | 76 | /* |
| 77 | * Internal Clients Number |
| 78 | */ |
Tomas Winkler | 781d0d8 | 2013-01-08 23:07:22 +0200 | [diff] [blame] | 79 | #define MEI_HOST_CLIENT_ID_ANY (-1) |
| 80 | #define MEI_HBM_HOST_CLIENT_ID 0 /* not used, just for documentation */ |
Tomas Winkler | 1d3f3da | 2012-12-25 19:06:01 +0200 | [diff] [blame] | 81 | #define MEI_WD_HOST_CLIENT_ID 1 |
| 82 | #define MEI_IAMTHIF_HOST_CLIENT_ID 2 |
| 83 | |
Oren Weil | ab84116 | 2011-05-15 13:43:41 +0300 | [diff] [blame] | 84 | |
| 85 | /* File state */ |
| 86 | enum file_state { |
| 87 | MEI_FILE_INITIALIZING = 0, |
| 88 | MEI_FILE_CONNECTING, |
| 89 | MEI_FILE_CONNECTED, |
| 90 | MEI_FILE_DISCONNECTING, |
Tomas Winkler | 3c66618 | 2015-05-04 09:43:52 +0300 | [diff] [blame] | 91 | MEI_FILE_DISCONNECT_REPLY, |
| 92 | MEI_FILE_DISCONNECTED, |
Oren Weil | ab84116 | 2011-05-15 13:43:41 +0300 | [diff] [blame] | 93 | }; |
| 94 | |
| 95 | /* MEI device states */ |
Tomas Winkler | b210d75 | 2012-08-07 00:03:56 +0300 | [diff] [blame] | 96 | enum mei_dev_state { |
| 97 | MEI_DEV_INITIALIZING = 0, |
| 98 | MEI_DEV_INIT_CLIENTS, |
| 99 | MEI_DEV_ENABLED, |
Bill Nottingham | 0cfee51 | 2013-04-19 22:01:36 +0300 | [diff] [blame] | 100 | MEI_DEV_RESETTING, |
Tomas Winkler | b210d75 | 2012-08-07 00:03:56 +0300 | [diff] [blame] | 101 | MEI_DEV_DISABLED, |
Tomas Winkler | b210d75 | 2012-08-07 00:03:56 +0300 | [diff] [blame] | 102 | MEI_DEV_POWER_DOWN, |
| 103 | MEI_DEV_POWER_UP |
Oren Weil | ab84116 | 2011-05-15 13:43:41 +0300 | [diff] [blame] | 104 | }; |
| 105 | |
Tomas Winkler | b210d75 | 2012-08-07 00:03:56 +0300 | [diff] [blame] | 106 | const char *mei_dev_state_str(int state); |
| 107 | |
Oren Weil | ab84116 | 2011-05-15 13:43:41 +0300 | [diff] [blame] | 108 | enum iamthif_states { |
| 109 | MEI_IAMTHIF_IDLE, |
| 110 | MEI_IAMTHIF_WRITING, |
| 111 | MEI_IAMTHIF_FLOW_CONTROL, |
| 112 | MEI_IAMTHIF_READING, |
| 113 | MEI_IAMTHIF_READ_COMPLETE |
| 114 | }; |
| 115 | |
| 116 | enum mei_file_transaction_states { |
| 117 | MEI_IDLE, |
| 118 | MEI_WRITING, |
| 119 | MEI_WRITE_COMPLETE, |
| 120 | MEI_FLOW_CONTROL, |
| 121 | MEI_READING, |
| 122 | MEI_READ_COMPLETE |
| 123 | }; |
| 124 | |
Tomas Winkler | c216fde | 2012-08-16 19:39:43 +0300 | [diff] [blame] | 125 | enum mei_wd_states { |
| 126 | MEI_WD_IDLE, |
| 127 | MEI_WD_RUNNING, |
| 128 | MEI_WD_STOPPING, |
| 129 | }; |
| 130 | |
Tomas Winkler | 4b8960b | 2012-11-11 17:38:00 +0200 | [diff] [blame] | 131 | /** |
| 132 | * enum mei_cb_file_ops - file operation associated with the callback |
Alexander Usyskin | ce23139 | 2014-09-29 16:31:50 +0300 | [diff] [blame] | 133 | * @MEI_FOP_READ: read |
| 134 | * @MEI_FOP_WRITE: write |
| 135 | * @MEI_FOP_CONNECT: connect |
| 136 | * @MEI_FOP_DISCONNECT: disconnect |
| 137 | * @MEI_FOP_DISCONNECT_RSP: disconnect response |
Tomas Winkler | 4b8960b | 2012-11-11 17:38:00 +0200 | [diff] [blame] | 138 | */ |
| 139 | enum mei_cb_file_ops { |
| 140 | MEI_FOP_READ = 0, |
| 141 | MEI_FOP_WRITE, |
Tomas Winkler | 02a7eec | 2014-02-12 21:41:51 +0200 | [diff] [blame] | 142 | MEI_FOP_CONNECT, |
Tomas Winkler | 5a8373f | 2014-08-21 14:29:17 +0300 | [diff] [blame] | 143 | MEI_FOP_DISCONNECT, |
Tomas Winkler | 6bb948c | 2014-02-12 21:41:52 +0200 | [diff] [blame] | 144 | MEI_FOP_DISCONNECT_RSP, |
Oren Weil | ab84116 | 2011-05-15 13:43:41 +0300 | [diff] [blame] | 145 | }; |
| 146 | |
| 147 | /* |
| 148 | * Intel MEI message data struct |
| 149 | */ |
Tomas Winkler | 4234a6d | 2013-04-08 21:56:37 +0300 | [diff] [blame] | 150 | struct mei_msg_data { |
Oren Weil | ab84116 | 2011-05-15 13:43:41 +0300 | [diff] [blame] | 151 | u32 size; |
Tomas Winkler | edf1eed | 2012-02-09 19:25:54 +0200 | [diff] [blame] | 152 | unsigned char *data; |
Tomas Winkler | f060939 | 2012-09-11 00:43:21 +0300 | [diff] [blame] | 153 | }; |
Oren Weil | ab84116 | 2011-05-15 13:43:41 +0300 | [diff] [blame] | 154 | |
Alexander Usyskin | 04dd366 | 2014-03-31 17:59:23 +0300 | [diff] [blame] | 155 | /* Maximum number of processed FW status registers */ |
Alexander Usyskin | edca5ea | 2014-11-19 17:01:38 +0200 | [diff] [blame] | 156 | #define MEI_FW_STATUS_MAX 6 |
| 157 | /* Minimal buffer for FW status string (8 bytes in dw + space or '\0') */ |
| 158 | #define MEI_FW_STATUS_STR_SZ (MEI_FW_STATUS_MAX * (8 + 1)) |
| 159 | |
Alexander Usyskin | 04dd366 | 2014-03-31 17:59:23 +0300 | [diff] [blame] | 160 | |
| 161 | /* |
| 162 | * struct mei_fw_status - storage of FW status data |
| 163 | * |
Alexander Usyskin | a8605ea | 2014-09-29 16:31:49 +0300 | [diff] [blame] | 164 | * @count: number of actually available elements in array |
| 165 | * @status: FW status registers |
Alexander Usyskin | 04dd366 | 2014-03-31 17:59:23 +0300 | [diff] [blame] | 166 | */ |
| 167 | struct mei_fw_status { |
| 168 | int count; |
| 169 | u32 status[MEI_FW_STATUS_MAX]; |
| 170 | }; |
| 171 | |
Tomas Winkler | db7da79 | 2012-12-25 19:06:05 +0200 | [diff] [blame] | 172 | /** |
| 173 | * struct mei_me_client - representation of me (fw) client |
| 174 | * |
Alexander Usyskin | a8605ea | 2014-09-29 16:31:49 +0300 | [diff] [blame] | 175 | * @list: link in me client list |
Tomas Winkler | 79563db | 2015-01-11 00:07:16 +0200 | [diff] [blame] | 176 | * @refcnt: struct reference count |
Alexander Usyskin | a8605ea | 2014-09-29 16:31:49 +0300 | [diff] [blame] | 177 | * @props: client properties |
| 178 | * @client_id: me client id |
| 179 | * @mei_flow_ctrl_creds: flow control credits |
Tomas Winkler | db7da79 | 2012-12-25 19:06:05 +0200 | [diff] [blame] | 180 | */ |
| 181 | struct mei_me_client { |
Tomas Winkler | 5ca2d38 | 2014-08-21 14:29:13 +0300 | [diff] [blame] | 182 | struct list_head list; |
Tomas Winkler | 79563db | 2015-01-11 00:07:16 +0200 | [diff] [blame] | 183 | struct kref refcnt; |
Tomas Winkler | db7da79 | 2012-12-25 19:06:05 +0200 | [diff] [blame] | 184 | struct mei_client_properties props; |
| 185 | u8 client_id; |
| 186 | u8 mei_flow_ctrl_creds; |
| 187 | }; |
| 188 | |
Oren Weil | ab84116 | 2011-05-15 13:43:41 +0300 | [diff] [blame] | 189 | |
Tomas Winkler | db3ed43 | 2012-11-11 17:37:59 +0200 | [diff] [blame] | 190 | struct mei_cl; |
| 191 | |
Tomas Winkler | 4b8960b | 2012-11-11 17:38:00 +0200 | [diff] [blame] | 192 | /** |
Tomas Winkler | db3ed43 | 2012-11-11 17:37:59 +0200 | [diff] [blame] | 193 | * struct mei_cl_cb - file operation callback structure |
| 194 | * |
Alexander Usyskin | a8605ea | 2014-09-29 16:31:49 +0300 | [diff] [blame] | 195 | * @list: link in callback queue |
| 196 | * @cl: file client who is running this operation |
| 197 | * @fop_type: file operation type |
Tomas Winkler | 5db7514 | 2015-02-10 10:39:42 +0200 | [diff] [blame] | 198 | * @buf: buffer for data associated with the callback |
Alexander Usyskin | ce23139 | 2014-09-29 16:31:50 +0300 | [diff] [blame] | 199 | * @buf_idx: last read index |
| 200 | * @read_time: last read operation time stamp (iamthif) |
| 201 | * @file_object: pointer to file structure |
Tomas Winkler | 3d33ff2 | 2015-02-10 10:39:36 +0200 | [diff] [blame] | 202 | * @status: io status of the cb |
Alexander Usyskin | ce23139 | 2014-09-29 16:31:50 +0300 | [diff] [blame] | 203 | * @internal: communication between driver and FW flag |
Tomas Winkler | 8660172 | 2015-02-10 10:39:40 +0200 | [diff] [blame] | 204 | * @completed: the transfer or reception has completed |
Tomas Winkler | db3ed43 | 2012-11-11 17:37:59 +0200 | [diff] [blame] | 205 | */ |
Oren Weil | ab84116 | 2011-05-15 13:43:41 +0300 | [diff] [blame] | 206 | struct mei_cl_cb { |
Tomas Winkler | fb601ad | 2012-10-15 12:06:48 +0200 | [diff] [blame] | 207 | struct list_head list; |
Tomas Winkler | db3ed43 | 2012-11-11 17:37:59 +0200 | [diff] [blame] | 208 | struct mei_cl *cl; |
Tomas Winkler | 4b8960b | 2012-11-11 17:38:00 +0200 | [diff] [blame] | 209 | enum mei_cb_file_ops fop_type; |
Tomas Winkler | 5db7514 | 2015-02-10 10:39:42 +0200 | [diff] [blame] | 210 | struct mei_msg_data buf; |
Tomas Winkler | ebb108ef | 2012-10-09 16:50:16 +0200 | [diff] [blame] | 211 | unsigned long buf_idx; |
Oren Weil | ab84116 | 2011-05-15 13:43:41 +0300 | [diff] [blame] | 212 | unsigned long read_time; |
| 213 | struct file *file_object; |
Tomas Winkler | 3d33ff2 | 2015-02-10 10:39:36 +0200 | [diff] [blame] | 214 | int status; |
Tomas Winkler | 479327f | 2013-12-17 15:56:56 +0200 | [diff] [blame] | 215 | u32 internal:1; |
Tomas Winkler | 8660172 | 2015-02-10 10:39:40 +0200 | [diff] [blame] | 216 | u32 completed:1; |
Oren Weil | ab84116 | 2011-05-15 13:43:41 +0300 | [diff] [blame] | 217 | }; |
| 218 | |
Alexander Usyskin | ce23139 | 2014-09-29 16:31:50 +0300 | [diff] [blame] | 219 | /** |
| 220 | * struct mei_cl - me client host representation |
| 221 | * carried in file->private_data |
| 222 | * |
| 223 | * @link: link in the clients list |
| 224 | * @dev: mei parent device |
| 225 | * @state: file operation state |
| 226 | * @tx_wait: wait queue for tx completion |
| 227 | * @rx_wait: wait queue for rx completion |
| 228 | * @wait: wait queue for management operation |
| 229 | * @status: connection status |
Alexander Usyskin | d49ed64 | 2015-05-04 09:43:54 +0300 | [diff] [blame^] | 230 | * @me_cl: fw client connected |
Alexander Usyskin | ce23139 | 2014-09-29 16:31:50 +0300 | [diff] [blame] | 231 | * @host_client_id: host id |
Alexander Usyskin | ce23139 | 2014-09-29 16:31:50 +0300 | [diff] [blame] | 232 | * @mei_flow_ctrl_creds: transmit flow credentials |
| 233 | * @timer_count: watchdog timer for operation completion |
Alexander Usyskin | d49ed64 | 2015-05-04 09:43:54 +0300 | [diff] [blame^] | 234 | * @reserved: reserved for alignment |
Alexander Usyskin | ce23139 | 2014-09-29 16:31:50 +0300 | [diff] [blame] | 235 | * @writing_state: state of the tx |
Tomas Winkler | a9bed61 | 2015-02-10 10:39:46 +0200 | [diff] [blame] | 236 | * @rd_pending: pending read credits |
| 237 | * @rd_completed: completed read |
Alexander Usyskin | ce23139 | 2014-09-29 16:31:50 +0300 | [diff] [blame] | 238 | * |
| 239 | * @device: device on the mei client bus |
| 240 | * @device_link: link to bus clients |
| 241 | */ |
Oren Weil | ab84116 | 2011-05-15 13:43:41 +0300 | [diff] [blame] | 242 | struct mei_cl { |
| 243 | struct list_head link; |
| 244 | struct mei_device *dev; |
| 245 | enum file_state state; |
| 246 | wait_queue_head_t tx_wait; |
| 247 | wait_queue_head_t rx_wait; |
| 248 | wait_queue_head_t wait; |
Oren Weil | ab84116 | 2011-05-15 13:43:41 +0300 | [diff] [blame] | 249 | int status; |
Alexander Usyskin | d49ed64 | 2015-05-04 09:43:54 +0300 | [diff] [blame^] | 250 | struct mei_me_client *me_cl; |
Oren Weil | ab84116 | 2011-05-15 13:43:41 +0300 | [diff] [blame] | 251 | u8 host_client_id; |
Oren Weil | ab84116 | 2011-05-15 13:43:41 +0300 | [diff] [blame] | 252 | u8 mei_flow_ctrl_creds; |
| 253 | u8 timer_count; |
Alexander Usyskin | d49ed64 | 2015-05-04 09:43:54 +0300 | [diff] [blame^] | 254 | u8 reserved; |
Oren Weil | ab84116 | 2011-05-15 13:43:41 +0300 | [diff] [blame] | 255 | enum mei_file_transaction_states writing_state; |
Tomas Winkler | a9bed61 | 2015-02-10 10:39:46 +0200 | [diff] [blame] | 256 | struct list_head rd_pending; |
| 257 | struct list_head rd_completed; |
Samuel Ortiz | a7b71bc | 2013-03-27 17:29:56 +0200 | [diff] [blame] | 258 | |
| 259 | /* MEI CL bus data */ |
| 260 | struct mei_cl_device *device; |
| 261 | struct list_head device_link; |
Oren Weil | ab84116 | 2011-05-15 13:43:41 +0300 | [diff] [blame] | 262 | }; |
| 263 | |
Tomas Winkler | 827eef5 | 2013-02-06 14:06:41 +0200 | [diff] [blame] | 264 | /** struct mei_hw_ops |
| 265 | * |
Alexander Usyskin | a8605ea | 2014-09-29 16:31:49 +0300 | [diff] [blame] | 266 | * @host_is_ready : query for host readiness |
Tomas Winkler | 827eef5 | 2013-02-06 14:06:41 +0200 | [diff] [blame] | 267 | |
Alexander Usyskin | a8605ea | 2014-09-29 16:31:49 +0300 | [diff] [blame] | 268 | * @hw_is_ready : query if hw is ready |
| 269 | * @hw_reset : reset hw |
| 270 | * @hw_start : start hw after reset |
| 271 | * @hw_config : configure hw |
Tomas Winkler | 827eef5 | 2013-02-06 14:06:41 +0200 | [diff] [blame] | 272 | |
Alexander Usyskin | a8605ea | 2014-09-29 16:31:49 +0300 | [diff] [blame] | 273 | * @fw_status : get fw status registers |
| 274 | * @pg_state : power gating state of the device |
| 275 | * @pg_is_enabled : is power gating enabled |
Tomas Winkler | ee7e5af | 2014-03-18 22:51:58 +0200 | [diff] [blame] | 276 | |
Alexander Usyskin | a8605ea | 2014-09-29 16:31:49 +0300 | [diff] [blame] | 277 | * @intr_clear : clear pending interrupts |
| 278 | * @intr_enable : enable interrupts |
| 279 | * @intr_disable : disable interrupts |
Tomas Winkler | 827eef5 | 2013-02-06 14:06:41 +0200 | [diff] [blame] | 280 | |
Alexander Usyskin | a8605ea | 2014-09-29 16:31:49 +0300 | [diff] [blame] | 281 | * @hbuf_free_slots : query for write buffer empty slots |
| 282 | * @hbuf_is_ready : query if write buffer is empty |
| 283 | * @hbuf_max_len : query for write buffer max len |
Tomas Winkler | 827eef5 | 2013-02-06 14:06:41 +0200 | [diff] [blame] | 284 | |
Alexander Usyskin | a8605ea | 2014-09-29 16:31:49 +0300 | [diff] [blame] | 285 | * @write : write a message to FW |
Tomas Winkler | 827eef5 | 2013-02-06 14:06:41 +0200 | [diff] [blame] | 286 | |
Alexander Usyskin | a8605ea | 2014-09-29 16:31:49 +0300 | [diff] [blame] | 287 | * @rdbuf_full_slots : query how many slots are filled |
Tomas Winkler | 827eef5 | 2013-02-06 14:06:41 +0200 | [diff] [blame] | 288 | |
Alexander Usyskin | a8605ea | 2014-09-29 16:31:49 +0300 | [diff] [blame] | 289 | * @read_hdr : get first 4 bytes (header) |
| 290 | * @read : read a buffer from the FW |
Tomas Winkler | 827eef5 | 2013-02-06 14:06:41 +0200 | [diff] [blame] | 291 | */ |
| 292 | struct mei_hw_ops { |
| 293 | |
Tomas Winkler | d63b309 | 2014-03-16 14:35:54 +0200 | [diff] [blame] | 294 | bool (*host_is_ready)(struct mei_device *dev); |
Tomas Winkler | 827eef5 | 2013-02-06 14:06:41 +0200 | [diff] [blame] | 295 | |
Tomas Winkler | d63b309 | 2014-03-16 14:35:54 +0200 | [diff] [blame] | 296 | bool (*hw_is_ready)(struct mei_device *dev); |
| 297 | int (*hw_reset)(struct mei_device *dev, bool enable); |
| 298 | int (*hw_start)(struct mei_device *dev); |
| 299 | void (*hw_config)(struct mei_device *dev); |
Tomas Winkler | 827eef5 | 2013-02-06 14:06:41 +0200 | [diff] [blame] | 300 | |
Tomas Winkler | 1bd30b6 | 2014-09-29 16:31:43 +0300 | [diff] [blame] | 301 | |
| 302 | int (*fw_status)(struct mei_device *dev, struct mei_fw_status *fw_sts); |
Tomas Winkler | 964a233 | 2014-03-18 22:51:59 +0200 | [diff] [blame] | 303 | enum mei_pg_state (*pg_state)(struct mei_device *dev); |
Tomas Winkler | ee7e5af | 2014-03-18 22:51:58 +0200 | [diff] [blame] | 304 | bool (*pg_is_enabled)(struct mei_device *dev); |
| 305 | |
Tomas Winkler | d63b309 | 2014-03-16 14:35:54 +0200 | [diff] [blame] | 306 | void (*intr_clear)(struct mei_device *dev); |
| 307 | void (*intr_enable)(struct mei_device *dev); |
| 308 | void (*intr_disable)(struct mei_device *dev); |
Tomas Winkler | 827eef5 | 2013-02-06 14:06:41 +0200 | [diff] [blame] | 309 | |
Tomas Winkler | d63b309 | 2014-03-16 14:35:54 +0200 | [diff] [blame] | 310 | int (*hbuf_free_slots)(struct mei_device *dev); |
| 311 | bool (*hbuf_is_ready)(struct mei_device *dev); |
| 312 | size_t (*hbuf_max_len)(const struct mei_device *dev); |
Tomas Winkler | 827eef5 | 2013-02-06 14:06:41 +0200 | [diff] [blame] | 313 | |
| 314 | int (*write)(struct mei_device *dev, |
| 315 | struct mei_msg_hdr *hdr, |
| 316 | unsigned char *buf); |
| 317 | |
| 318 | int (*rdbuf_full_slots)(struct mei_device *dev); |
| 319 | |
| 320 | u32 (*read_hdr)(const struct mei_device *dev); |
Tomas Winkler | d63b309 | 2014-03-16 14:35:54 +0200 | [diff] [blame] | 321 | int (*read)(struct mei_device *dev, |
Tomas Winkler | 827eef5 | 2013-02-06 14:06:41 +0200 | [diff] [blame] | 322 | unsigned char *buf, unsigned long len); |
| 323 | }; |
| 324 | |
Samuel Ortiz | e535410 | 2013-03-27 17:29:53 +0200 | [diff] [blame] | 325 | /* MEI bus API*/ |
Samuel Ortiz | 3e83329 | 2013-03-27 17:29:55 +0200 | [diff] [blame] | 326 | |
| 327 | /** |
Samuel Ortiz | e46980a | 2013-04-09 01:51:38 +0300 | [diff] [blame] | 328 | * struct mei_cl_ops - MEI CL device ops |
Samuel Ortiz | 3e83329 | 2013-03-27 17:29:55 +0200 | [diff] [blame] | 329 | * This structure allows ME host clients to implement technology |
Samuel Ortiz | e46980a | 2013-04-09 01:51:38 +0300 | [diff] [blame] | 330 | * specific operations. |
Samuel Ortiz | 3e83329 | 2013-03-27 17:29:55 +0200 | [diff] [blame] | 331 | * |
Samuel Ortiz | e46980a | 2013-04-09 01:51:38 +0300 | [diff] [blame] | 332 | * @enable: Enable an MEI CL device. Some devices require specific |
| 333 | * HECI commands to initialize completely. |
| 334 | * @disable: Disable an MEI CL device. |
Samuel Ortiz | 3e83329 | 2013-03-27 17:29:55 +0200 | [diff] [blame] | 335 | * @send: Tx hook for the device. This allows ME host clients to trap |
| 336 | * the device driver buffers before actually physically |
| 337 | * pushing it to the ME. |
| 338 | * @recv: Rx hook for the device. This allows ME host clients to trap the |
| 339 | * ME buffers before forwarding them to the device driver. |
| 340 | */ |
Samuel Ortiz | e46980a | 2013-04-09 01:51:38 +0300 | [diff] [blame] | 341 | struct mei_cl_ops { |
| 342 | int (*enable)(struct mei_cl_device *device); |
| 343 | int (*disable)(struct mei_cl_device *device); |
Samuel Ortiz | 3e83329 | 2013-03-27 17:29:55 +0200 | [diff] [blame] | 344 | int (*send)(struct mei_cl_device *device, u8 *buf, size_t length); |
| 345 | int (*recv)(struct mei_cl_device *device, u8 *buf, size_t length); |
| 346 | }; |
| 347 | |
Samuel Ortiz | e46980a | 2013-04-09 01:51:38 +0300 | [diff] [blame] | 348 | struct mei_cl_device *mei_cl_add_device(struct mei_device *dev, |
Alexander Usyskin | d49ed64 | 2015-05-04 09:43:54 +0300 | [diff] [blame^] | 349 | struct mei_me_client *me_cl, |
| 350 | struct mei_cl *cl, |
| 351 | char *name, |
Samuel Ortiz | e46980a | 2013-04-09 01:51:38 +0300 | [diff] [blame] | 352 | struct mei_cl_ops *ops); |
| 353 | void mei_cl_remove_device(struct mei_cl_device *device); |
| 354 | |
Tomas Winkler | 39db74c | 2014-11-27 14:07:28 +0200 | [diff] [blame] | 355 | ssize_t __mei_cl_async_send(struct mei_cl *cl, u8 *buf, size_t length); |
| 356 | ssize_t __mei_cl_send(struct mei_cl *cl, u8 *buf, size_t length); |
| 357 | ssize_t __mei_cl_recv(struct mei_cl *cl, u8 *buf, size_t length); |
Samuel Ortiz | cf3baef | 2013-03-27 17:29:57 +0200 | [diff] [blame] | 358 | void mei_cl_bus_rx_event(struct mei_cl *cl); |
Tomas Winkler | 4870569 | 2014-02-17 15:13:19 +0200 | [diff] [blame] | 359 | void mei_cl_bus_remove_devices(struct mei_device *dev); |
Samuel Ortiz | cf3baef | 2013-03-27 17:29:57 +0200 | [diff] [blame] | 360 | int mei_cl_bus_init(void); |
| 361 | void mei_cl_bus_exit(void); |
Tomas Winkler | a176c24 | 2014-11-05 18:18:52 +0200 | [diff] [blame] | 362 | struct mei_cl *mei_cl_bus_find_cl_by_uuid(struct mei_device *dev, uuid_le uuid); |
Samuel Ortiz | cf3baef | 2013-03-27 17:29:57 +0200 | [diff] [blame] | 363 | |
| 364 | |
Samuel Ortiz | e535410 | 2013-03-27 17:29:53 +0200 | [diff] [blame] | 365 | /** |
| 366 | * struct mei_cl_device - MEI device handle |
| 367 | * An mei_cl_device pointer is returned from mei_add_device() |
| 368 | * and links MEI bus clients to their actual ME host client pointer. |
| 369 | * Drivers for MEI devices will get an mei_cl_device pointer |
| 370 | * when being probed and shall use it for doing ME bus I/O. |
| 371 | * |
| 372 | * @dev: linux driver model device pointer |
Alexander Usyskin | d49ed64 | 2015-05-04 09:43:54 +0300 | [diff] [blame^] | 373 | * @me_cl: me client |
Samuel Ortiz | e535410 | 2013-03-27 17:29:53 +0200 | [diff] [blame] | 374 | * @cl: mei client |
Samuel Ortiz | 3e83329 | 2013-03-27 17:29:55 +0200 | [diff] [blame] | 375 | * @ops: ME transport ops |
Alexander Usyskin | ce23139 | 2014-09-29 16:31:50 +0300 | [diff] [blame] | 376 | * @event_work: async work to execute event callback |
Samuel Ortiz | 3e83329 | 2013-03-27 17:29:55 +0200 | [diff] [blame] | 377 | * @event_cb: Drivers register this callback to get asynchronous ME |
| 378 | * events (e.g. Rx buffer pending) notifications. |
Alexander Usyskin | ce23139 | 2014-09-29 16:31:50 +0300 | [diff] [blame] | 379 | * @event_context: event callback run context |
Samuel Ortiz | 3e83329 | 2013-03-27 17:29:55 +0200 | [diff] [blame] | 380 | * @events: Events bitmask sent to the driver. |
Samuel Ortiz | e535410 | 2013-03-27 17:29:53 +0200 | [diff] [blame] | 381 | * @priv_data: client private data |
| 382 | */ |
| 383 | struct mei_cl_device { |
| 384 | struct device dev; |
| 385 | |
Alexander Usyskin | d49ed64 | 2015-05-04 09:43:54 +0300 | [diff] [blame^] | 386 | struct mei_me_client *me_cl; |
Samuel Ortiz | e535410 | 2013-03-27 17:29:53 +0200 | [diff] [blame] | 387 | struct mei_cl *cl; |
| 388 | |
Samuel Ortiz | e46980a | 2013-04-09 01:51:38 +0300 | [diff] [blame] | 389 | const struct mei_cl_ops *ops; |
Samuel Ortiz | 3e83329 | 2013-03-27 17:29:55 +0200 | [diff] [blame] | 390 | |
| 391 | struct work_struct event_work; |
| 392 | mei_cl_event_cb_t event_cb; |
| 393 | void *event_context; |
| 394 | unsigned long events; |
| 395 | |
Samuel Ortiz | e535410 | 2013-03-27 17:29:53 +0200 | [diff] [blame] | 396 | void *priv_data; |
| 397 | }; |
| 398 | |
Tomas Winkler | 964a233 | 2014-03-18 22:51:59 +0200 | [diff] [blame] | 399 | |
Alexander Usyskin | ce23139 | 2014-09-29 16:31:50 +0300 | [diff] [blame] | 400 | /** |
Tomas Winkler | 964a233 | 2014-03-18 22:51:59 +0200 | [diff] [blame] | 401 | * enum mei_pg_event - power gating transition events |
| 402 | * |
| 403 | * @MEI_PG_EVENT_IDLE: the driver is not in power gating transition |
| 404 | * @MEI_PG_EVENT_WAIT: the driver is waiting for a pg event to complete |
| 405 | * @MEI_PG_EVENT_RECEIVED: the driver received pg event |
| 406 | */ |
| 407 | enum mei_pg_event { |
| 408 | MEI_PG_EVENT_IDLE, |
| 409 | MEI_PG_EVENT_WAIT, |
| 410 | MEI_PG_EVENT_RECEIVED, |
| 411 | }; |
| 412 | |
| 413 | /** |
| 414 | * enum mei_pg_state - device internal power gating state |
| 415 | * |
| 416 | * @MEI_PG_OFF: device is not power gated - it is active |
| 417 | * @MEI_PG_ON: device is power gated - it is in lower power state |
| 418 | */ |
| 419 | enum mei_pg_state { |
| 420 | MEI_PG_OFF = 0, |
| 421 | MEI_PG_ON = 1, |
| 422 | }; |
| 423 | |
Alexander Usyskin | 1beeb4b | 2014-09-29 16:31:33 +0300 | [diff] [blame] | 424 | const char *mei_pg_state_str(enum mei_pg_state state); |
| 425 | |
Tomas Winkler | 24aadc8 | 2012-06-25 23:46:27 +0300 | [diff] [blame] | 426 | /** |
Tomas Winkler | 5fb54fb | 2012-11-18 15:13:15 +0200 | [diff] [blame] | 427 | * struct mei_device - MEI private device struct |
Alexander Usyskin | ce23139 | 2014-09-29 16:31:50 +0300 | [diff] [blame] | 428 | * |
Alexander Usyskin | a8605ea | 2014-09-29 16:31:49 +0300 | [diff] [blame] | 429 | * @dev : device on a bus |
| 430 | * @cdev : character device |
| 431 | * @minor : minor number allocated for device |
Alexander Usyskin | f3d8e87 | 2014-06-23 15:10:35 +0300 | [diff] [blame] | 432 | * |
Alexander Usyskin | ce23139 | 2014-09-29 16:31:50 +0300 | [diff] [blame] | 433 | * @write_list : write pending list |
| 434 | * @write_waiting_list : write completion list |
| 435 | * @ctrl_wr_list : pending control write list |
| 436 | * @ctrl_rd_list : pending control read list |
Tomas Winkler | bae1cc7 | 2014-08-21 14:29:21 +0300 | [diff] [blame] | 437 | * |
Alexander Usyskin | ce23139 | 2014-09-29 16:31:50 +0300 | [diff] [blame] | 438 | * @file_list : list of opened handles |
| 439 | * @open_handle_count: number of opened handles |
| 440 | * |
| 441 | * @device_lock : big device lock |
| 442 | * @timer_work : MEI timer delayed work (timeouts) |
| 443 | * |
| 444 | * @recvd_hw_ready : hw ready message received flag |
| 445 | * |
| 446 | * @wait_hw_ready : wait queue for receive HW ready message form FW |
| 447 | * @wait_pg : wait queue for receive PG message from FW |
| 448 | * @wait_hbm_start : wait queue for receive HBM start message from FW |
| 449 | * @wait_stop_wd : wait queue for receive WD stop message from FW |
| 450 | * |
| 451 | * @reset_count : number of consecutive resets |
| 452 | * @dev_state : device state |
| 453 | * @hbm_state : state of host bus message protocol |
| 454 | * @init_clients_timer : HBM init handshake timeout |
Tomas Winkler | bae1cc7 | 2014-08-21 14:29:21 +0300 | [diff] [blame] | 455 | * |
Alexander Usyskin | a8605ea | 2014-09-29 16:31:49 +0300 | [diff] [blame] | 456 | * @pg_event : power gating event |
Alexander Usyskin | ce23139 | 2014-09-29 16:31:50 +0300 | [diff] [blame] | 457 | * @pg_domain : runtime PM domain |
| 458 | * |
| 459 | * @rd_msg_buf : control messages buffer |
| 460 | * @rd_msg_hdr : read message header storage |
| 461 | * |
Alexander Usyskin | a8605ea | 2014-09-29 16:31:49 +0300 | [diff] [blame] | 462 | * @hbuf_depth : depth of hardware host/write buffer is slots |
| 463 | * @hbuf_is_ready : query if the host host/write buffer is ready |
| 464 | * @wr_msg : the buffer for hbm control messages |
Alexander Usyskin | ce23139 | 2014-09-29 16:31:50 +0300 | [diff] [blame] | 465 | * |
| 466 | * @version : HBM protocol version in use |
| 467 | * @hbm_f_pg_supported : hbm feature pgi protocol |
| 468 | * |
Tomas Winkler | b7d8851 | 2015-02-10 10:39:31 +0200 | [diff] [blame] | 469 | * @me_clients_rwsem: rw lock over me_clients list |
Alexander Usyskin | ce23139 | 2014-09-29 16:31:50 +0300 | [diff] [blame] | 470 | * @me_clients : list of FW clients |
| 471 | * @me_clients_map : FW clients bit map |
| 472 | * @host_clients_map : host clients id pool |
| 473 | * @me_client_index : last FW client index in enumeration |
| 474 | * |
| 475 | * @wd_cl : watchdog client |
| 476 | * @wd_state : watchdog client state |
| 477 | * @wd_pending : watchdog command is pending |
| 478 | * @wd_timeout : watchdog expiration timeout |
| 479 | * @wd_data : watchdog message buffer |
| 480 | * |
| 481 | * @amthif_cmd_list : amthif list for cmd waiting |
| 482 | * @amthif_rd_complete_list : amthif list for reading completed cmd data |
| 483 | * @iamthif_file_object : file for current amthif operation |
| 484 | * @iamthif_cl : amthif host client |
| 485 | * @iamthif_current_cb : amthif current operation callback |
| 486 | * @iamthif_open_count : number of opened amthif connections |
| 487 | * @iamthif_mtu : amthif client max message length |
| 488 | * @iamthif_timer : time stamp of current amthif command completion |
| 489 | * @iamthif_stall_timer : timer to detect amthif hang |
Alexander Usyskin | ce23139 | 2014-09-29 16:31:50 +0300 | [diff] [blame] | 490 | * @iamthif_state : amthif processor state |
Alexander Usyskin | ce23139 | 2014-09-29 16:31:50 +0300 | [diff] [blame] | 491 | * @iamthif_canceled : current amthif command is canceled |
| 492 | * |
| 493 | * @init_work : work item for the device init |
| 494 | * @reset_work : work item for the device reset |
| 495 | * |
| 496 | * @device_list : mei client bus list |
| 497 | * |
| 498 | * @dbgfs_dir : debugfs mei root directory |
| 499 | * |
| 500 | * @ops: : hw specific operations |
| 501 | * @hw : hw specific data |
Tomas Winkler | 24aadc8 | 2012-06-25 23:46:27 +0300 | [diff] [blame] | 502 | */ |
Oren Weil | ab84116 | 2011-05-15 13:43:41 +0300 | [diff] [blame] | 503 | struct mei_device { |
Tomas Winkler | 3a7e9b6 | 2014-09-29 16:31:41 +0300 | [diff] [blame] | 504 | struct device *dev; |
Alexander Usyskin | f3d8e87 | 2014-06-23 15:10:35 +0300 | [diff] [blame] | 505 | struct cdev cdev; |
| 506 | int minor; |
| 507 | |
Alexander Usyskin | ce23139 | 2014-09-29 16:31:50 +0300 | [diff] [blame] | 508 | struct mei_cl_cb write_list; |
| 509 | struct mei_cl_cb write_waiting_list; |
| 510 | struct mei_cl_cb ctrl_wr_list; |
| 511 | struct mei_cl_cb ctrl_rd_list; |
Oren Weil | ab84116 | 2011-05-15 13:43:41 +0300 | [diff] [blame] | 512 | |
Oren Weil | ab84116 | 2011-05-15 13:43:41 +0300 | [diff] [blame] | 513 | struct list_head file_list; |
Tomas Winkler | eb9af0a | 2011-05-25 17:28:22 +0300 | [diff] [blame] | 514 | long open_handle_count; |
Tomas Winkler | fecb0d5 | 2012-12-25 19:06:04 +0200 | [diff] [blame] | 515 | |
Alexander Usyskin | ce23139 | 2014-09-29 16:31:50 +0300 | [diff] [blame] | 516 | struct mutex device_lock; |
| 517 | struct delayed_work timer_work; |
Tomas Winkler | aafae7e | 2013-03-11 18:27:03 +0200 | [diff] [blame] | 518 | |
| 519 | bool recvd_hw_ready; |
Oren Weil | ab84116 | 2011-05-15 13:43:41 +0300 | [diff] [blame] | 520 | /* |
| 521 | * waiting queue for receive message from FW |
| 522 | */ |
Tomas Winkler | aafae7e | 2013-03-11 18:27:03 +0200 | [diff] [blame] | 523 | wait_queue_head_t wait_hw_ready; |
Tomas Winkler | 4fcbc99 | 2014-03-18 22:51:55 +0200 | [diff] [blame] | 524 | wait_queue_head_t wait_pg; |
Alexander Usyskin | cb02efc | 2014-08-21 14:29:19 +0300 | [diff] [blame] | 525 | wait_queue_head_t wait_hbm_start; |
Oren Weil | ab84116 | 2011-05-15 13:43:41 +0300 | [diff] [blame] | 526 | wait_queue_head_t wait_stop_wd; |
| 527 | |
| 528 | /* |
| 529 | * mei device states |
| 530 | */ |
Tomas Winkler | 6adb8ef | 2014-01-12 00:36:10 +0200 | [diff] [blame] | 531 | unsigned long reset_count; |
Tomas Winkler | b210d75 | 2012-08-07 00:03:56 +0300 | [diff] [blame] | 532 | enum mei_dev_state dev_state; |
Tomas Winkler | 9b0d5ef | 2013-04-18 23:03:48 +0300 | [diff] [blame] | 533 | enum mei_hbm_state hbm_state; |
Oren Weil | ab84116 | 2011-05-15 13:43:41 +0300 | [diff] [blame] | 534 | u16 init_clients_timer; |
Oren Weil | ab84116 | 2011-05-15 13:43:41 +0300 | [diff] [blame] | 535 | |
Tomas Winkler | 964a233 | 2014-03-18 22:51:59 +0200 | [diff] [blame] | 536 | /* |
| 537 | * Power Gating support |
| 538 | */ |
| 539 | enum mei_pg_event pg_event; |
Rafael J. Wysocki | bbd6d050 | 2014-12-04 22:43:07 +0100 | [diff] [blame] | 540 | #ifdef CONFIG_PM |
Tomas Winkler | e13fa90 | 2014-03-18 22:52:05 +0200 | [diff] [blame] | 541 | struct dev_pm_domain pg_domain; |
Rafael J. Wysocki | bbd6d050 | 2014-12-04 22:43:07 +0100 | [diff] [blame] | 542 | #endif /* CONFIG_PM */ |
Tomas Winkler | 964a233 | 2014-03-18 22:51:59 +0200 | [diff] [blame] | 543 | |
Alexander Usyskin | ce23139 | 2014-09-29 16:31:50 +0300 | [diff] [blame] | 544 | unsigned char rd_msg_buf[MEI_RD_MSG_BUF_SIZE]; |
Oren Weil | ab84116 | 2011-05-15 13:43:41 +0300 | [diff] [blame] | 545 | u32 rd_msg_hdr; |
Tomas Winkler | e46f187 | 2012-12-25 19:06:10 +0200 | [diff] [blame] | 546 | |
Tomas Winkler | 330dd7d | 2013-02-06 14:06:43 +0200 | [diff] [blame] | 547 | /* write buffer */ |
| 548 | u8 hbuf_depth; |
| 549 | bool hbuf_is_ready; |
| 550 | |
Tomas Winkler | e46f187 | 2012-12-25 19:06:10 +0200 | [diff] [blame] | 551 | /* used for control messages */ |
| 552 | struct { |
| 553 | struct mei_msg_hdr hdr; |
| 554 | unsigned char data[128]; |
| 555 | } wr_msg; |
| 556 | |
Oren Weil | ab84116 | 2011-05-15 13:43:41 +0300 | [diff] [blame] | 557 | struct hbm_version version; |
Tomas Winkler | bae1cc7 | 2014-08-21 14:29:21 +0300 | [diff] [blame] | 558 | unsigned int hbm_f_pg_supported:1; |
Oren Weil | ab84116 | 2011-05-15 13:43:41 +0300 | [diff] [blame] | 559 | |
Tomas Winkler | b7d8851 | 2015-02-10 10:39:31 +0200 | [diff] [blame] | 560 | struct rw_semaphore me_clients_rwsem; |
Tomas Winkler | 5ca2d38 | 2014-08-21 14:29:13 +0300 | [diff] [blame] | 561 | struct list_head me_clients; |
Oren Weil | ab84116 | 2011-05-15 13:43:41 +0300 | [diff] [blame] | 562 | DECLARE_BITMAP(me_clients_map, MEI_CLIENTS_MAX); |
| 563 | DECLARE_BITMAP(host_clients_map, MEI_CLIENTS_MAX); |
Tomas Winkler | 1aee351 | 2013-09-02 13:29:45 +0300 | [diff] [blame] | 564 | unsigned long me_client_index; |
Oren Weil | ab84116 | 2011-05-15 13:43:41 +0300 | [diff] [blame] | 565 | |
Tomas Winkler | eb9af0a | 2011-05-25 17:28:22 +0300 | [diff] [blame] | 566 | struct mei_cl wd_cl; |
Tomas Winkler | c216fde | 2012-08-16 19:39:43 +0300 | [diff] [blame] | 567 | enum mei_wd_states wd_state; |
Tomas Winkler | eb9af0a | 2011-05-25 17:28:22 +0300 | [diff] [blame] | 568 | bool wd_pending; |
Tomas Winkler | c216fde | 2012-08-16 19:39:43 +0300 | [diff] [blame] | 569 | u16 wd_timeout; |
Tomas Winkler | 248ffdf | 2012-08-16 19:39:42 +0300 | [diff] [blame] | 570 | unsigned char wd_data[MEI_WD_START_MSG_SIZE]; |
Oren Weil | ab84116 | 2011-05-15 13:43:41 +0300 | [diff] [blame] | 571 | |
| 572 | |
Tomas Winkler | e773efc | 2012-11-11 17:37:58 +0200 | [diff] [blame] | 573 | /* amthif list for cmd waiting */ |
| 574 | struct mei_cl_cb amthif_cmd_list; |
| 575 | /* driver managed amthif list for reading completed amthif cmd data */ |
| 576 | struct mei_cl_cb amthif_rd_complete_list; |
Oren Weil | ab84116 | 2011-05-15 13:43:41 +0300 | [diff] [blame] | 577 | struct file *iamthif_file_object; |
| 578 | struct mei_cl iamthif_cl; |
Tomas Winkler | eb9af0a | 2011-05-25 17:28:22 +0300 | [diff] [blame] | 579 | struct mei_cl_cb *iamthif_current_cb; |
Tomas Winkler | 22f96a0 | 2013-09-16 23:44:47 +0300 | [diff] [blame] | 580 | long iamthif_open_count; |
Oren Weil | ab84116 | 2011-05-15 13:43:41 +0300 | [diff] [blame] | 581 | int iamthif_mtu; |
| 582 | unsigned long iamthif_timer; |
| 583 | u32 iamthif_stall_timer; |
Oren Weil | ab84116 | 2011-05-15 13:43:41 +0300 | [diff] [blame] | 584 | enum iamthif_states iamthif_state; |
Tomas Winkler | eb9af0a | 2011-05-25 17:28:22 +0300 | [diff] [blame] | 585 | bool iamthif_canceled; |
Samuel Ortiz | c1174c0 | 2012-11-18 15:13:20 +0200 | [diff] [blame] | 586 | |
| 587 | struct work_struct init_work; |
Tomas Winkler | 544f946 | 2014-01-08 20:19:21 +0200 | [diff] [blame] | 588 | struct work_struct reset_work; |
Tomas Winkler | 827eef5 | 2013-02-06 14:06:41 +0200 | [diff] [blame] | 589 | |
Samuel Ortiz | a7b71bc | 2013-03-27 17:29:56 +0200 | [diff] [blame] | 590 | /* List of bus devices */ |
| 591 | struct list_head device_list; |
| 592 | |
Tomas Winkler | 30e53bb | 2013-04-05 22:10:34 +0300 | [diff] [blame] | 593 | #if IS_ENABLED(CONFIG_DEBUG_FS) |
| 594 | struct dentry *dbgfs_dir; |
| 595 | #endif /* CONFIG_DEBUG_FS */ |
| 596 | |
| 597 | |
Tomas Winkler | 827eef5 | 2013-02-06 14:06:41 +0200 | [diff] [blame] | 598 | const struct mei_hw_ops *ops; |
Tomas Winkler | 52c3456 | 2013-02-06 14:06:40 +0200 | [diff] [blame] | 599 | char hw[0] __aligned(sizeof(void *)); |
Oren Weil | ab84116 | 2011-05-15 13:43:41 +0300 | [diff] [blame] | 600 | }; |
| 601 | |
Tomas Winkler | 3870c32 | 2012-11-01 21:17:14 +0200 | [diff] [blame] | 602 | static inline unsigned long mei_secs_to_jiffies(unsigned long sec) |
| 603 | { |
| 604 | return msecs_to_jiffies(sec * MSEC_PER_SEC); |
| 605 | } |
| 606 | |
Tomas Winkler | c8c8d08 | 2013-03-11 18:27:02 +0200 | [diff] [blame] | 607 | /** |
| 608 | * mei_data2slots - get slots - number of (dwords) from a message length |
| 609 | * + size of the mei header |
Alexander Usyskin | ce23139 | 2014-09-29 16:31:50 +0300 | [diff] [blame] | 610 | * |
Alexander Usyskin | a8605ea | 2014-09-29 16:31:49 +0300 | [diff] [blame] | 611 | * @length: size of the messages in bytes |
| 612 | * |
| 613 | * Return: number of slots |
Tomas Winkler | c8c8d08 | 2013-03-11 18:27:02 +0200 | [diff] [blame] | 614 | */ |
| 615 | static inline u32 mei_data2slots(size_t length) |
| 616 | { |
| 617 | return DIV_ROUND_UP(sizeof(struct mei_msg_hdr) + length, 4); |
| 618 | } |
| 619 | |
Tomas Winkler | 10ee907 | 2013-11-11 13:26:08 +0200 | [diff] [blame] | 620 | /** |
Alexander Usyskin | ce23139 | 2014-09-29 16:31:50 +0300 | [diff] [blame] | 621 | * mei_slots2data - get data in slots - bytes from slots |
| 622 | * |
Alexander Usyskin | a8605ea | 2014-09-29 16:31:49 +0300 | [diff] [blame] | 623 | * @slots: number of available slots |
Alexander Usyskin | ce23139 | 2014-09-29 16:31:50 +0300 | [diff] [blame] | 624 | * |
Alexander Usyskin | a8605ea | 2014-09-29 16:31:49 +0300 | [diff] [blame] | 625 | * Return: number of bytes in slots |
Tomas Winkler | 10ee907 | 2013-11-11 13:26:08 +0200 | [diff] [blame] | 626 | */ |
| 627 | static inline u32 mei_slots2data(int slots) |
| 628 | { |
| 629 | return slots * 4; |
| 630 | } |
| 631 | |
Oren Weil | ab84116 | 2011-05-15 13:43:41 +0300 | [diff] [blame] | 632 | /* |
| 633 | * mei init function prototypes |
| 634 | */ |
Tomas Winkler | 3a7e9b6 | 2014-09-29 16:31:41 +0300 | [diff] [blame] | 635 | void mei_device_init(struct mei_device *dev, |
| 636 | struct device *device, |
| 637 | const struct mei_hw_ops *hw_ops); |
Tomas Winkler | 33ec082 | 2014-01-12 00:36:09 +0200 | [diff] [blame] | 638 | int mei_reset(struct mei_device *dev); |
Tomas Winkler | c4d589b | 2013-03-27 16:58:28 +0200 | [diff] [blame] | 639 | int mei_start(struct mei_device *dev); |
Tomas Winkler | 33ec082 | 2014-01-12 00:36:09 +0200 | [diff] [blame] | 640 | int mei_restart(struct mei_device *dev); |
Tomas Winkler | 7cb035d | 2013-03-10 13:56:08 +0200 | [diff] [blame] | 641 | void mei_stop(struct mei_device *dev); |
Tomas Winkler | dc844b0 | 2013-11-11 13:26:06 +0200 | [diff] [blame] | 642 | void mei_cancel_work(struct mei_device *dev); |
Tomas Winkler | c95efb7 | 2011-05-25 17:28:21 +0300 | [diff] [blame] | 643 | |
Tomas Winkler | c95efb7 | 2011-05-25 17:28:21 +0300 | [diff] [blame] | 644 | /* |
| 645 | * MEI interrupt functions prototype |
Oren Weil | ab84116 | 2011-05-15 13:43:41 +0300 | [diff] [blame] | 646 | */ |
Tomas Winkler | 06ecd64 | 2013-02-06 14:06:42 +0200 | [diff] [blame] | 647 | |
Oren Weil | a61c653 | 2011-09-07 09:03:13 +0300 | [diff] [blame] | 648 | void mei_timer(struct work_struct *work); |
Tomas Winkler | 06ecd64 | 2013-02-06 14:06:42 +0200 | [diff] [blame] | 649 | int mei_irq_read_handler(struct mei_device *dev, |
| 650 | struct mei_cl_cb *cmpl_list, s32 *slots); |
| 651 | |
| 652 | int mei_irq_write_handler(struct mei_device *dev, struct mei_cl_cb *cmpl_list); |
Tomas Winkler | 4c6e22b | 2013-03-17 11:41:20 +0200 | [diff] [blame] | 653 | void mei_irq_compl_handler(struct mei_device *dev, struct mei_cl_cb *cmpl_list); |
Oren Weil | ab84116 | 2011-05-15 13:43:41 +0300 | [diff] [blame] | 654 | |
| 655 | /* |
Tomas Winkler | 19838fb | 2012-11-01 21:17:15 +0200 | [diff] [blame] | 656 | * AMTHIF - AMT Host Interface Functions |
| 657 | */ |
| 658 | void mei_amthif_reset_params(struct mei_device *dev); |
| 659 | |
Alexander Usyskin | d49ed64 | 2015-05-04 09:43:54 +0300 | [diff] [blame^] | 660 | int mei_amthif_host_init(struct mei_device *dev, struct mei_me_client *me_cl); |
Tomas Winkler | 19838fb | 2012-11-01 21:17:15 +0200 | [diff] [blame] | 661 | |
Tomas Winkler | 19838fb | 2012-11-01 21:17:15 +0200 | [diff] [blame] | 662 | int mei_amthif_read(struct mei_device *dev, struct file *file, |
Tomas Winkler | 744f0f2 | 2012-11-11 17:38:02 +0200 | [diff] [blame] | 663 | char __user *ubuf, size_t length, loff_t *offset); |
| 664 | |
| 665 | unsigned int mei_amthif_poll(struct mei_device *dev, |
| 666 | struct file *file, poll_table *wait); |
Oren Weil | ab84116 | 2011-05-15 13:43:41 +0300 | [diff] [blame] | 667 | |
Tomas Winkler | a562d5c | 2012-11-11 17:38:01 +0200 | [diff] [blame] | 668 | int mei_amthif_release(struct mei_device *dev, struct file *file); |
| 669 | |
Tomas Winkler | 19838fb | 2012-11-01 21:17:15 +0200 | [diff] [blame] | 670 | struct mei_cl_cb *mei_amthif_find_read_list_entry(struct mei_device *dev, |
Oren Weil | ab84116 | 2011-05-15 13:43:41 +0300 | [diff] [blame] | 671 | struct file *file); |
| 672 | |
Tomas Winkler | 8660172 | 2015-02-10 10:39:40 +0200 | [diff] [blame] | 673 | int mei_amthif_write(struct mei_cl *cl, struct mei_cl_cb *cb); |
| 674 | int mei_amthif_run_next_cmd(struct mei_device *dev); |
Tomas Winkler | 9d09819 | 2014-02-19 17:35:48 +0200 | [diff] [blame] | 675 | int mei_amthif_irq_write(struct mei_cl *cl, struct mei_cl_cb *cb, |
| 676 | struct mei_cl_cb *cmpl_list); |
Tomas Winkler | 5ceb46e | 2013-04-19 21:16:53 +0300 | [diff] [blame] | 677 | |
| 678 | void mei_amthif_complete(struct mei_device *dev, struct mei_cl_cb *cb); |
Tomas Winkler | db4756f | 2015-02-10 10:39:37 +0200 | [diff] [blame] | 679 | int mei_amthif_irq_read_msg(struct mei_cl *cl, |
Tomas Winkler | 5ceb46e | 2013-04-19 21:16:53 +0300 | [diff] [blame] | 680 | struct mei_msg_hdr *mei_hdr, |
| 681 | struct mei_cl_cb *complete_list); |
| 682 | int mei_amthif_irq_read(struct mei_device *dev, s32 *slots); |
| 683 | |
Samuel Ortiz | 59fcd7c | 2013-04-11 03:03:29 +0200 | [diff] [blame] | 684 | /* |
| 685 | * NFC functions |
| 686 | */ |
Alexander Usyskin | d49ed64 | 2015-05-04 09:43:54 +0300 | [diff] [blame^] | 687 | int mei_nfc_host_init(struct mei_device *dev, struct mei_me_client *me_cl); |
Tomas Winkler | dc844b0 | 2013-11-11 13:26:06 +0200 | [diff] [blame] | 688 | void mei_nfc_host_exit(struct mei_device *dev); |
Samuel Ortiz | 59fcd7c | 2013-04-11 03:03:29 +0200 | [diff] [blame] | 689 | |
| 690 | /* |
| 691 | * NFC Client UUID |
| 692 | */ |
| 693 | extern const uuid_le mei_nfc_guid; |
Oren Weil | ab84116 | 2011-05-15 13:43:41 +0300 | [diff] [blame] | 694 | |
Tomas Winkler | 37e7d6e | 2013-01-08 23:07:16 +0200 | [diff] [blame] | 695 | int mei_wd_send(struct mei_device *dev); |
| 696 | int mei_wd_stop(struct mei_device *dev); |
Alexander Usyskin | d49ed64 | 2015-05-04 09:43:54 +0300 | [diff] [blame^] | 697 | int mei_wd_host_init(struct mei_device *dev, struct mei_me_client *me_cl); |
Tomas Winkler | 37e7d6e | 2013-01-08 23:07:16 +0200 | [diff] [blame] | 698 | /* |
| 699 | * mei_watchdog_register - Registering watchdog interface |
| 700 | * once we got connection to the WD Client |
Alexander Usyskin | a8605ea | 2014-09-29 16:31:49 +0300 | [diff] [blame] | 701 | * @dev: mei device |
Tomas Winkler | 37e7d6e | 2013-01-08 23:07:16 +0200 | [diff] [blame] | 702 | */ |
Tomas Winkler | 6409285 | 2014-02-17 15:13:21 +0200 | [diff] [blame] | 703 | int mei_watchdog_register(struct mei_device *dev); |
Tomas Winkler | 37e7d6e | 2013-01-08 23:07:16 +0200 | [diff] [blame] | 704 | /* |
| 705 | * mei_watchdog_unregister - Unregistering watchdog interface |
Alexander Usyskin | a8605ea | 2014-09-29 16:31:49 +0300 | [diff] [blame] | 706 | * @dev: mei device |
Tomas Winkler | 37e7d6e | 2013-01-08 23:07:16 +0200 | [diff] [blame] | 707 | */ |
| 708 | void mei_watchdog_unregister(struct mei_device *dev); |
| 709 | |
Oren Weil | ab84116 | 2011-05-15 13:43:41 +0300 | [diff] [blame] | 710 | /* |
| 711 | * Register Access Function |
| 712 | */ |
| 713 | |
Alexander Usyskin | 8d929d4 | 2014-05-13 01:30:53 +0300 | [diff] [blame] | 714 | |
Tomas Winkler | 827eef5 | 2013-02-06 14:06:41 +0200 | [diff] [blame] | 715 | static inline void mei_hw_config(struct mei_device *dev) |
| 716 | { |
| 717 | dev->ops->hw_config(dev); |
| 718 | } |
Tomas Winkler | ee7e5af | 2014-03-18 22:51:58 +0200 | [diff] [blame] | 719 | |
Tomas Winkler | 964a233 | 2014-03-18 22:51:59 +0200 | [diff] [blame] | 720 | static inline enum mei_pg_state mei_pg_state(struct mei_device *dev) |
| 721 | { |
| 722 | return dev->ops->pg_state(dev); |
| 723 | } |
| 724 | |
Tomas Winkler | ee7e5af | 2014-03-18 22:51:58 +0200 | [diff] [blame] | 725 | static inline bool mei_pg_is_enabled(struct mei_device *dev) |
| 726 | { |
| 727 | return dev->ops->pg_is_enabled(dev); |
| 728 | } |
| 729 | |
Tomas Winkler | c20c68d | 2013-06-23 10:42:49 +0300 | [diff] [blame] | 730 | static inline int mei_hw_reset(struct mei_device *dev, bool enable) |
Tomas Winkler | 827eef5 | 2013-02-06 14:06:41 +0200 | [diff] [blame] | 731 | { |
Tomas Winkler | c20c68d | 2013-06-23 10:42:49 +0300 | [diff] [blame] | 732 | return dev->ops->hw_reset(dev, enable); |
Tomas Winkler | 827eef5 | 2013-02-06 14:06:41 +0200 | [diff] [blame] | 733 | } |
Oren Weil | ab84116 | 2011-05-15 13:43:41 +0300 | [diff] [blame] | 734 | |
Tomas Winkler | 9049f79 | 2013-06-23 22:49:04 +0300 | [diff] [blame] | 735 | static inline int mei_hw_start(struct mei_device *dev) |
Tomas Winkler | aafae7e | 2013-03-11 18:27:03 +0200 | [diff] [blame] | 736 | { |
Tomas Winkler | 9049f79 | 2013-06-23 22:49:04 +0300 | [diff] [blame] | 737 | return dev->ops->hw_start(dev); |
Tomas Winkler | aafae7e | 2013-03-11 18:27:03 +0200 | [diff] [blame] | 738 | } |
| 739 | |
Tomas Winkler | 827eef5 | 2013-02-06 14:06:41 +0200 | [diff] [blame] | 740 | static inline void mei_clear_interrupts(struct mei_device *dev) |
| 741 | { |
| 742 | dev->ops->intr_clear(dev); |
| 743 | } |
Oren Weil | ab84116 | 2011-05-15 13:43:41 +0300 | [diff] [blame] | 744 | |
Tomas Winkler | 827eef5 | 2013-02-06 14:06:41 +0200 | [diff] [blame] | 745 | static inline void mei_enable_interrupts(struct mei_device *dev) |
| 746 | { |
| 747 | dev->ops->intr_enable(dev); |
| 748 | } |
Tomas Winkler | e7e0c23 | 2013-01-08 23:07:31 +0200 | [diff] [blame] | 749 | |
Tomas Winkler | 827eef5 | 2013-02-06 14:06:41 +0200 | [diff] [blame] | 750 | static inline void mei_disable_interrupts(struct mei_device *dev) |
| 751 | { |
| 752 | dev->ops->intr_disable(dev); |
| 753 | } |
Oren Weil | ab84116 | 2011-05-15 13:43:41 +0300 | [diff] [blame] | 754 | |
Tomas Winkler | 827eef5 | 2013-02-06 14:06:41 +0200 | [diff] [blame] | 755 | static inline bool mei_host_is_ready(struct mei_device *dev) |
| 756 | { |
| 757 | return dev->ops->host_is_ready(dev); |
| 758 | } |
| 759 | static inline bool mei_hw_is_ready(struct mei_device *dev) |
| 760 | { |
| 761 | return dev->ops->hw_is_ready(dev); |
| 762 | } |
Tomas Winkler | 115ba28 | 2013-01-08 23:07:29 +0200 | [diff] [blame] | 763 | |
Tomas Winkler | 827eef5 | 2013-02-06 14:06:41 +0200 | [diff] [blame] | 764 | static inline bool mei_hbuf_is_ready(struct mei_device *dev) |
| 765 | { |
| 766 | return dev->ops->hbuf_is_ready(dev); |
| 767 | } |
Tomas Winkler | 3a65dd4 | 2012-12-25 19:06:06 +0200 | [diff] [blame] | 768 | |
Tomas Winkler | 827eef5 | 2013-02-06 14:06:41 +0200 | [diff] [blame] | 769 | static inline int mei_hbuf_empty_slots(struct mei_device *dev) |
| 770 | { |
| 771 | return dev->ops->hbuf_free_slots(dev); |
| 772 | } |
| 773 | |
| 774 | static inline size_t mei_hbuf_max_len(const struct mei_device *dev) |
| 775 | { |
| 776 | return dev->ops->hbuf_max_len(dev); |
| 777 | } |
| 778 | |
| 779 | static inline int mei_write_message(struct mei_device *dev, |
| 780 | struct mei_msg_hdr *hdr, |
| 781 | unsigned char *buf) |
| 782 | { |
| 783 | return dev->ops->write(dev, hdr, buf); |
| 784 | } |
| 785 | |
| 786 | static inline u32 mei_read_hdr(const struct mei_device *dev) |
| 787 | { |
| 788 | return dev->ops->read_hdr(dev); |
| 789 | } |
| 790 | |
| 791 | static inline void mei_read_slots(struct mei_device *dev, |
| 792 | unsigned char *buf, unsigned long len) |
| 793 | { |
| 794 | dev->ops->read(dev, buf, len); |
| 795 | } |
| 796 | |
| 797 | static inline int mei_count_full_read_slots(struct mei_device *dev) |
| 798 | { |
| 799 | return dev->ops->rdbuf_full_slots(dev); |
| 800 | } |
Tomas Winkler | 5bd6471 | 2012-11-18 15:13:14 +0200 | [diff] [blame] | 801 | |
Tomas Winkler | 1bd30b6 | 2014-09-29 16:31:43 +0300 | [diff] [blame] | 802 | static inline int mei_fw_status(struct mei_device *dev, |
| 803 | struct mei_fw_status *fw_status) |
| 804 | { |
| 805 | return dev->ops->fw_status(dev, fw_status); |
| 806 | } |
Alexander Usyskin | 04dd366 | 2014-03-31 17:59:23 +0300 | [diff] [blame] | 807 | |
Tomas Winkler | 6aae48f | 2014-02-19 17:35:47 +0200 | [diff] [blame] | 808 | bool mei_hbuf_acquire(struct mei_device *dev); |
| 809 | |
Tomas Winkler | a532bbe | 2014-03-18 22:52:01 +0200 | [diff] [blame] | 810 | bool mei_write_is_idle(struct mei_device *dev); |
| 811 | |
Tomas Winkler | 30e53bb | 2013-04-05 22:10:34 +0300 | [diff] [blame] | 812 | #if IS_ENABLED(CONFIG_DEBUG_FS) |
| 813 | int mei_dbgfs_register(struct mei_device *dev, const char *name); |
| 814 | void mei_dbgfs_deregister(struct mei_device *dev); |
| 815 | #else |
| 816 | static inline int mei_dbgfs_register(struct mei_device *dev, const char *name) |
| 817 | { |
| 818 | return 0; |
| 819 | } |
| 820 | static inline void mei_dbgfs_deregister(struct mei_device *dev) {} |
| 821 | #endif /* CONFIG_DEBUG_FS */ |
| 822 | |
Alexander Usyskin | f3d8e87 | 2014-06-23 15:10:35 +0300 | [diff] [blame] | 823 | int mei_register(struct mei_device *dev, struct device *parent); |
Tomas Winkler | 30e53bb | 2013-04-05 22:10:34 +0300 | [diff] [blame] | 824 | void mei_deregister(struct mei_device *dev); |
Tomas Winkler | 2703d4b | 2013-02-06 14:06:39 +0200 | [diff] [blame] | 825 | |
Tomas Winkler | 479327f | 2013-12-17 15:56:56 +0200 | [diff] [blame] | 826 | #define MEI_HDR_FMT "hdr:host=%02d me=%02d len=%d internal=%1d comp=%1d" |
Tomas Winkler | 15d4acc | 2012-12-25 19:06:00 +0200 | [diff] [blame] | 827 | #define MEI_HDR_PRM(hdr) \ |
| 828 | (hdr)->host_addr, (hdr)->me_addr, \ |
Tomas Winkler | 479327f | 2013-12-17 15:56:56 +0200 | [diff] [blame] | 829 | (hdr)->length, (hdr)->internal, (hdr)->msg_complete |
Tomas Winkler | 15d4acc | 2012-12-25 19:06:00 +0200 | [diff] [blame] | 830 | |
Alexander Usyskin | edca5ea | 2014-11-19 17:01:38 +0200 | [diff] [blame] | 831 | ssize_t mei_fw_status2str(struct mei_fw_status *fw_sts, char *buf, size_t len); |
| 832 | /** |
| 833 | * mei_fw_status_str - fetch and convert fw status registers to printable string |
| 834 | * |
| 835 | * @dev: the device structure |
| 836 | * @buf: string buffer at minimal size MEI_FW_STATUS_STR_SZ |
| 837 | * @len: buffer len must be >= MEI_FW_STATUS_STR_SZ |
| 838 | * |
| 839 | * Return: number of bytes written or < 0 on failure |
| 840 | */ |
| 841 | static inline ssize_t mei_fw_status_str(struct mei_device *dev, |
| 842 | char *buf, size_t len) |
| 843 | { |
| 844 | struct mei_fw_status fw_status; |
| 845 | int ret; |
| 846 | |
| 847 | buf[0] = '\0'; |
| 848 | |
| 849 | ret = mei_fw_status(dev, &fw_status); |
| 850 | if (ret) |
| 851 | return ret; |
| 852 | |
| 853 | ret = mei_fw_status2str(&fw_status, buf, MEI_FW_STATUS_STR_SZ); |
| 854 | |
| 855 | return ret; |
| 856 | } |
| 857 | |
| 858 | |
Oren Weil | ab84116 | 2011-05-15 13:43:41 +0300 | [diff] [blame] | 859 | #endif |