1 /* 2 * Management Module Support for MPT (Message Passing Technology) based 3 * controllers 4 * 5 * This code is based on drivers/scsi/mpt2sas/mpt2_ctl.h 6 * Copyright (C) 2007-2010 LSI Corporation 7 * (mailto:DL-MPTFusionLinux@lsi.com) 8 * 9 * This program is free software; you can redistribute it and/or 10 * modify it under the terms of the GNU General Public License 11 * as published by the Free Software Foundation; either version 2 12 * of the License, or (at your option) any later version. 13 * 14 * This program is distributed in the hope that it will be useful, 15 * but WITHOUT ANY WARRANTY; without even the implied warranty of 16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 17 * GNU General Public License for more details. 18 * 19 * NO WARRANTY 20 * THE PROGRAM IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR 21 * CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT 22 * LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT, 23 * MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Each Recipient is 24 * solely responsible for determining the appropriateness of using and 25 * distributing the Program and assumes all risks associated with its 26 * exercise of rights under this Agreement, including but not limited to 27 * the risks and costs of program errors, damage to or loss of data, 28 * programs or equipment, and unavailability or interruption of operations. 29 30 * DISCLAIMER OF LIABILITY 31 * NEITHER RECIPIENT NOR ANY CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY 32 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 33 * DAMAGES (INCLUDING WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED AND 34 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR 35 * TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE 36 * USE OR DISTRIBUTION OF THE PROGRAM OR THE EXERCISE OF ANY RIGHTS GRANTED 37 * HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES 38 39 * You should have received a copy of the GNU General Public License 40 * along with this program; if not, write to the Free Software 41 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, 42 * USA. 43 */ 44 45 #ifndef MPT2SAS_CTL_H_INCLUDED 46 #define MPT2SAS_CTL_H_INCLUDED 47 48 #ifdef __KERNEL__ 49 #include <linux/miscdevice.h> 50 #endif 51 52 #define MPT2SAS_DEV_NAME "mpt2ctl" 53 #define MPT2_MAGIC_NUMBER 'L' 54 #define MPT2_IOCTL_DEFAULT_TIMEOUT (10) /* in seconds */ 55 56 /** 57 * IOCTL opcodes 58 */ 59 #define MPT2IOCINFO _IOWR(MPT2_MAGIC_NUMBER, 17, \ 60 struct mpt2_ioctl_iocinfo) 61 #define MPT2COMMAND _IOWR(MPT2_MAGIC_NUMBER, 20, \ 62 struct mpt2_ioctl_command) 63 #ifdef CONFIG_COMPAT 64 #define MPT2COMMAND32 _IOWR(MPT2_MAGIC_NUMBER, 20, \ 65 struct mpt2_ioctl_command32) 66 #endif 67 #define MPT2EVENTQUERY _IOWR(MPT2_MAGIC_NUMBER, 21, \ 68 struct mpt2_ioctl_eventquery) 69 #define MPT2EVENTENABLE _IOWR(MPT2_MAGIC_NUMBER, 22, \ 70 struct mpt2_ioctl_eventenable) 71 #define MPT2EVENTREPORT _IOWR(MPT2_MAGIC_NUMBER, 23, \ 72 struct mpt2_ioctl_eventreport) 73 #define MPT2HARDRESET _IOWR(MPT2_MAGIC_NUMBER, 24, \ 74 struct mpt2_ioctl_diag_reset) 75 #define MPT2BTDHMAPPING _IOWR(MPT2_MAGIC_NUMBER, 31, \ 76 struct mpt2_ioctl_btdh_mapping) 77 78 /* diag buffer support */ 79 #define MPT2DIAGREGISTER _IOWR(MPT2_MAGIC_NUMBER, 26, \ 80 struct mpt2_diag_register) 81 #define MPT2DIAGRELEASE _IOWR(MPT2_MAGIC_NUMBER, 27, \ 82 struct mpt2_diag_release) 83 #define MPT2DIAGUNREGISTER _IOWR(MPT2_MAGIC_NUMBER, 28, \ 84 struct mpt2_diag_unregister) 85 #define MPT2DIAGQUERY _IOWR(MPT2_MAGIC_NUMBER, 29, \ 86 struct mpt2_diag_query) 87 #define MPT2DIAGREADBUFFER _IOWR(MPT2_MAGIC_NUMBER, 30, \ 88 struct mpt2_diag_read_buffer) 89 90 /** 91 * struct mpt2_ioctl_header - main header structure 92 * @ioc_number - IOC unit number 93 * @port_number - IOC port number 94 * @max_data_size - maximum number bytes to transfer on read 95 */ 96 struct mpt2_ioctl_header { 97 uint32_t ioc_number; 98 uint32_t port_number; 99 uint32_t max_data_size; 100 }; 101 102 /** 103 * struct mpt2_ioctl_diag_reset - diagnostic reset 104 * @hdr - generic header 105 */ 106 struct mpt2_ioctl_diag_reset { 107 struct mpt2_ioctl_header hdr; 108 }; 109 110 111 /** 112 * struct mpt2_ioctl_pci_info - pci device info 113 * @device - pci device id 114 * @function - pci function id 115 * @bus - pci bus id 116 * @segment_id - pci segment id 117 */ 118 struct mpt2_ioctl_pci_info { 119 union { 120 struct { 121 uint32_t device:5; 122 uint32_t function:3; 123 uint32_t bus:24; 124 } bits; 125 uint32_t word; 126 } u; 127 uint32_t segment_id; 128 }; 129 130 131 #define MPT2_IOCTL_INTERFACE_SCSI (0x00) 132 #define MPT2_IOCTL_INTERFACE_FC (0x01) 133 #define MPT2_IOCTL_INTERFACE_FC_IP (0x02) 134 #define MPT2_IOCTL_INTERFACE_SAS (0x03) 135 #define MPT2_IOCTL_INTERFACE_SAS2 (0x04) 136 #define MPT2_IOCTL_VERSION_LENGTH (32) 137 138 /** 139 * struct mpt2_ioctl_iocinfo - generic controller info 140 * @hdr - generic header 141 * @adapter_type - type of adapter (spi, fc, sas) 142 * @port_number - port number 143 * @pci_id - PCI Id 144 * @hw_rev - hardware revision 145 * @sub_system_device - PCI subsystem Device ID 146 * @sub_system_vendor - PCI subsystem Vendor ID 147 * @rsvd0 - reserved 148 * @firmware_version - firmware version 149 * @bios_version - BIOS version 150 * @driver_version - driver version - 32 ASCII characters 151 * @rsvd1 - reserved 152 * @scsi_id - scsi id of adapter 0 153 * @rsvd2 - reserved 154 * @pci_information - pci info (2nd revision) 155 */ 156 struct mpt2_ioctl_iocinfo { 157 struct mpt2_ioctl_header hdr; 158 uint32_t adapter_type; 159 uint32_t port_number; 160 uint32_t pci_id; 161 uint32_t hw_rev; 162 uint32_t subsystem_device; 163 uint32_t subsystem_vendor; 164 uint32_t rsvd0; 165 uint32_t firmware_version; 166 uint32_t bios_version; 167 uint8_t driver_version[MPT2_IOCTL_VERSION_LENGTH]; 168 uint8_t rsvd1; 169 uint8_t scsi_id; 170 uint16_t rsvd2; 171 struct mpt2_ioctl_pci_info pci_information; 172 }; 173 174 175 /* number of event log entries */ 176 #define MPT2SAS_CTL_EVENT_LOG_SIZE (50) 177 178 /** 179 * struct mpt2_ioctl_eventquery - query event count and type 180 * @hdr - generic header 181 * @event_entries - number of events returned by get_event_report 182 * @rsvd - reserved 183 * @event_types - type of events currently being captured 184 */ 185 struct mpt2_ioctl_eventquery { 186 struct mpt2_ioctl_header hdr; 187 uint16_t event_entries; 188 uint16_t rsvd; 189 uint32_t event_types[MPI2_EVENT_NOTIFY_EVENTMASK_WORDS]; 190 }; 191 192 /** 193 * struct mpt2_ioctl_eventenable - enable/disable event capturing 194 * @hdr - generic header 195 * @event_types - toggle off/on type of events to be captured 196 */ 197 struct mpt2_ioctl_eventenable { 198 struct mpt2_ioctl_header hdr; 199 uint32_t event_types[4]; 200 }; 201 202 #define MPT2_EVENT_DATA_SIZE (192) 203 /** 204 * struct MPT2_IOCTL_EVENTS - 205 * @event - the event that was reported 206 * @context - unique value for each event assigned by driver 207 * @data - event data returned in fw reply message 208 */ 209 struct MPT2_IOCTL_EVENTS { 210 uint32_t event; 211 uint32_t context; 212 uint8_t data[MPT2_EVENT_DATA_SIZE]; 213 }; 214 215 /** 216 * struct mpt2_ioctl_eventreport - returing event log 217 * @hdr - generic header 218 * @event_data - (see struct MPT2_IOCTL_EVENTS) 219 */ 220 struct mpt2_ioctl_eventreport { 221 struct mpt2_ioctl_header hdr; 222 struct MPT2_IOCTL_EVENTS event_data[1]; 223 }; 224 225 /** 226 * struct mpt2_ioctl_command - generic mpt firmware passthru ioclt 227 * @hdr - generic header 228 * @timeout - command timeout in seconds. (if zero then use driver default 229 * value). 230 * @reply_frame_buf_ptr - reply location 231 * @data_in_buf_ptr - destination for read 232 * @data_out_buf_ptr - data source for write 233 * @sense_data_ptr - sense data location 234 * @max_reply_bytes - maximum number of reply bytes to be sent to app. 235 * @data_in_size - number bytes for data transfer in (read) 236 * @data_out_size - number bytes for data transfer out (write) 237 * @max_sense_bytes - maximum number of bytes for auto sense buffers 238 * @data_sge_offset - offset in words from the start of the request message to 239 * the first SGL 240 * @mf[1]; 241 */ 242 struct mpt2_ioctl_command { 243 struct mpt2_ioctl_header hdr; 244 uint32_t timeout; 245 void __user *reply_frame_buf_ptr; 246 void __user *data_in_buf_ptr; 247 void __user *data_out_buf_ptr; 248 void __user *sense_data_ptr; 249 uint32_t max_reply_bytes; 250 uint32_t data_in_size; 251 uint32_t data_out_size; 252 uint32_t max_sense_bytes; 253 uint32_t data_sge_offset; 254 uint8_t mf[1]; 255 }; 256 257 #ifdef CONFIG_COMPAT 258 struct mpt2_ioctl_command32 { 259 struct mpt2_ioctl_header hdr; 260 uint32_t timeout; 261 uint32_t reply_frame_buf_ptr; 262 uint32_t data_in_buf_ptr; 263 uint32_t data_out_buf_ptr; 264 uint32_t sense_data_ptr; 265 uint32_t max_reply_bytes; 266 uint32_t data_in_size; 267 uint32_t data_out_size; 268 uint32_t max_sense_bytes; 269 uint32_t data_sge_offset; 270 uint8_t mf[1]; 271 }; 272 #endif 273 274 /** 275 * struct mpt2_ioctl_btdh_mapping - mapping info 276 * @hdr - generic header 277 * @id - target device identification number 278 * @bus - SCSI bus number that the target device exists on 279 * @handle - device handle for the target device 280 * @rsvd - reserved 281 * 282 * To obtain a bus/id the application sets 283 * handle to valid handle, and bus/id to 0xFFFF. 284 * 285 * To obtain the device handle the application sets 286 * bus/id valid value, and the handle to 0xFFFF. 287 */ 288 struct mpt2_ioctl_btdh_mapping { 289 struct mpt2_ioctl_header hdr; 290 uint32_t id; 291 uint32_t bus; 292 uint16_t handle; 293 uint16_t rsvd; 294 }; 295 296 297 /* status bits for ioc->diag_buffer_status */ 298 #define MPT2_DIAG_BUFFER_IS_REGISTERED (0x01) 299 #define MPT2_DIAG_BUFFER_IS_RELEASED (0x02) 300 #define MPT2_DIAG_BUFFER_IS_DIAG_RESET (0x04) 301 302 /* application flags for mpt2_diag_register, mpt2_diag_query */ 303 #define MPT2_APP_FLAGS_APP_OWNED (0x0001) 304 #define MPT2_APP_FLAGS_BUFFER_VALID (0x0002) 305 #define MPT2_APP_FLAGS_FW_BUFFER_ACCESS (0x0004) 306 307 /* flags for mpt2_diag_read_buffer */ 308 #define MPT2_FLAGS_REREGISTER (0x0001) 309 310 #define MPT2_PRODUCT_SPECIFIC_DWORDS 23 311 312 /** 313 * struct mpt2_diag_register - application register with driver 314 * @hdr - generic header 315 * @reserved - 316 * @buffer_type - specifies either TRACE, SNAPSHOT, or EXTENDED 317 * @application_flags - misc flags 318 * @diagnostic_flags - specifies flags affecting command processing 319 * @product_specific - product specific information 320 * @requested_buffer_size - buffers size in bytes 321 * @unique_id - tag specified by application that is used to signal ownership 322 * of the buffer. 323 * 324 * This will allow the driver to setup any required buffers that will be 325 * needed by firmware to communicate with the driver. 326 */ 327 struct mpt2_diag_register { 328 struct mpt2_ioctl_header hdr; 329 uint8_t reserved; 330 uint8_t buffer_type; 331 uint16_t application_flags; 332 uint32_t diagnostic_flags; 333 uint32_t product_specific[MPT2_PRODUCT_SPECIFIC_DWORDS]; 334 uint32_t requested_buffer_size; 335 uint32_t unique_id; 336 }; 337 338 /** 339 * struct mpt2_diag_unregister - application unregister with driver 340 * @hdr - generic header 341 * @unique_id - tag uniquely identifies the buffer to be unregistered 342 * 343 * This will allow the driver to cleanup any memory allocated for diag 344 * messages and to free up any resources. 345 */ 346 struct mpt2_diag_unregister { 347 struct mpt2_ioctl_header hdr; 348 uint32_t unique_id; 349 }; 350 351 /** 352 * struct mpt2_diag_query - query relevant info associated with diag buffers 353 * @hdr - generic header 354 * @reserved - 355 * @buffer_type - specifies either TRACE, SNAPSHOT, or EXTENDED 356 * @application_flags - misc flags 357 * @diagnostic_flags - specifies flags affecting command processing 358 * @product_specific - product specific information 359 * @total_buffer_size - diag buffer size in bytes 360 * @driver_added_buffer_size - size of extra space appended to end of buffer 361 * @unique_id - unique id associated with this buffer. 362 * 363 * The application will send only buffer_type and unique_id. Driver will 364 * inspect unique_id first, if valid, fill in all the info. If unique_id is 365 * 0x00, the driver will return info specified by Buffer Type. 366 */ 367 struct mpt2_diag_query { 368 struct mpt2_ioctl_header hdr; 369 uint8_t reserved; 370 uint8_t buffer_type; 371 uint16_t application_flags; 372 uint32_t diagnostic_flags; 373 uint32_t product_specific[MPT2_PRODUCT_SPECIFIC_DWORDS]; 374 uint32_t total_buffer_size; 375 uint32_t driver_added_buffer_size; 376 uint32_t unique_id; 377 }; 378 379 /** 380 * struct mpt2_diag_release - request to send Diag Release Message to firmware 381 * @hdr - generic header 382 * @unique_id - tag uniquely identifies the buffer to be released 383 * 384 * This allows ownership of the specified buffer to returned to the driver, 385 * allowing an application to read the buffer without fear that firmware is 386 * overwritting information in the buffer. 387 */ 388 struct mpt2_diag_release { 389 struct mpt2_ioctl_header hdr; 390 uint32_t unique_id; 391 }; 392 393 /** 394 * struct mpt2_diag_read_buffer - request for copy of the diag buffer 395 * @hdr - generic header 396 * @status - 397 * @reserved - 398 * @flags - misc flags 399 * @starting_offset - starting offset within drivers buffer where to start 400 * reading data at into the specified application buffer 401 * @bytes_to_read - number of bytes to copy from the drivers buffer into the 402 * application buffer starting at starting_offset. 403 * @unique_id - unique id associated with this buffer. 404 * @diagnostic_data - data payload 405 */ 406 struct mpt2_diag_read_buffer { 407 struct mpt2_ioctl_header hdr; 408 uint8_t status; 409 uint8_t reserved; 410 uint16_t flags; 411 uint32_t starting_offset; 412 uint32_t bytes_to_read; 413 uint32_t unique_id; 414 uint32_t diagnostic_data[1]; 415 }; 416 417 #endif /* MPT2SAS_CTL_H_INCLUDED */ 418