i2o-dev.h 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421
  1. /*
  2. * I2O user space accessible structures/APIs
  3. *
  4. * (c) Copyright 1999, 2000 Red Hat Software
  5. *
  6. * This program is free software; you can redistribute it and/or
  7. * modify it under the terms of the GNU General Public License
  8. * as published by the Free Software Foundation; either version
  9. * 2 of the License, or (at your option) any later version.
  10. *
  11. *************************************************************************
  12. *
  13. * This header file defines the I2O APIs that are available to both
  14. * the kernel and user level applications. Kernel specific structures
  15. * are defined in i2o_osm. OSMs should include _only_ i2o_osm.h which
  16. * automatically includes this file.
  17. *
  18. */
  19. #ifndef _I2O_DEV_H
  20. #define _I2O_DEV_H
  21. /* How many controllers are we allowing */
  22. #define MAX_I2O_CONTROLLERS 32
  23. #include <linux/ioctl.h>
  24. #include <linux/types.h>
  25. /*
  26. * I2O Control IOCTLs and structures
  27. */
  28. #define I2O_MAGIC_NUMBER 'i'
  29. #define I2OGETIOPS _IOR(I2O_MAGIC_NUMBER,0,__u8[MAX_I2O_CONTROLLERS])
  30. #define I2OHRTGET _IOWR(I2O_MAGIC_NUMBER,1,struct i2o_cmd_hrtlct)
  31. #define I2OLCTGET _IOWR(I2O_MAGIC_NUMBER,2,struct i2o_cmd_hrtlct)
  32. #define I2OPARMSET _IOWR(I2O_MAGIC_NUMBER,3,struct i2o_cmd_psetget)
  33. #define I2OPARMGET _IOWR(I2O_MAGIC_NUMBER,4,struct i2o_cmd_psetget)
  34. #define I2OSWDL _IOWR(I2O_MAGIC_NUMBER,5,struct i2o_sw_xfer)
  35. #define I2OSWUL _IOWR(I2O_MAGIC_NUMBER,6,struct i2o_sw_xfer)
  36. #define I2OSWDEL _IOWR(I2O_MAGIC_NUMBER,7,struct i2o_sw_xfer)
  37. #define I2OVALIDATE _IOR(I2O_MAGIC_NUMBER,8,__u32)
  38. #define I2OHTML _IOWR(I2O_MAGIC_NUMBER,9,struct i2o_html)
  39. #define I2OEVTREG _IOW(I2O_MAGIC_NUMBER,10,struct i2o_evt_id)
  40. #define I2OEVTGET _IOR(I2O_MAGIC_NUMBER,11,struct i2o_evt_info)
  41. #define I2OPASSTHRU _IOR(I2O_MAGIC_NUMBER,12,struct i2o_cmd_passthru)
  42. #define I2OPASSTHRU32 _IOR(I2O_MAGIC_NUMBER,12,struct i2o_cmd_passthru32)
  43. struct i2o_cmd_passthru32 {
  44. unsigned int iop; /* IOP unit number */
  45. __u32 msg; /* message */
  46. };
  47. struct i2o_cmd_passthru {
  48. unsigned int iop; /* IOP unit number */
  49. void __user *msg; /* message */
  50. };
  51. struct i2o_cmd_hrtlct {
  52. unsigned int iop; /* IOP unit number */
  53. void __user *resbuf; /* Buffer for result */
  54. unsigned int __user *reslen; /* Buffer length in bytes */
  55. };
  56. struct i2o_cmd_psetget {
  57. unsigned int iop; /* IOP unit number */
  58. unsigned int tid; /* Target device TID */
  59. void __user *opbuf; /* Operation List buffer */
  60. unsigned int oplen; /* Operation List buffer length in bytes */
  61. void __user *resbuf; /* Result List buffer */
  62. unsigned int __user *reslen; /* Result List buffer length in bytes */
  63. };
  64. struct i2o_sw_xfer {
  65. unsigned int iop; /* IOP unit number */
  66. unsigned char flags; /* Flags field */
  67. unsigned char sw_type; /* Software type */
  68. unsigned int sw_id; /* Software ID */
  69. void __user *buf; /* Pointer to software buffer */
  70. unsigned int __user *swlen; /* Length of software data */
  71. unsigned int __user *maxfrag; /* Maximum fragment count */
  72. unsigned int __user *curfrag; /* Current fragment count */
  73. };
  74. struct i2o_html {
  75. unsigned int iop; /* IOP unit number */
  76. unsigned int tid; /* Target device ID */
  77. unsigned int page; /* HTML page */
  78. void __user *resbuf; /* Buffer for reply HTML page */
  79. unsigned int __user *reslen; /* Length in bytes of reply buffer */
  80. void __user *qbuf; /* Pointer to HTTP query string */
  81. unsigned int qlen; /* Length in bytes of query string buffer */
  82. };
  83. #define I2O_EVT_Q_LEN 32
  84. struct i2o_evt_id {
  85. unsigned int iop;
  86. unsigned int tid;
  87. unsigned int evt_mask;
  88. };
  89. /* Event data size = frame size - message header + evt indicator */
  90. #define I2O_EVT_DATA_SIZE 88
  91. struct i2o_evt_info {
  92. struct i2o_evt_id id;
  93. unsigned char evt_data[I2O_EVT_DATA_SIZE];
  94. unsigned int data_size;
  95. };
  96. struct i2o_evt_get {
  97. struct i2o_evt_info info;
  98. int pending;
  99. int lost;
  100. };
  101. typedef struct i2o_sg_io_hdr {
  102. unsigned int flags; /* see I2O_DPT_SG_IO_FLAGS */
  103. } i2o_sg_io_hdr_t;
  104. /**************************************************************************
  105. * HRT related constants and structures
  106. **************************************************************************/
  107. #define I2O_BUS_LOCAL 0
  108. #define I2O_BUS_ISA 1
  109. #define I2O_BUS_EISA 2
  110. /* was I2O_BUS_MCA 3 */
  111. #define I2O_BUS_PCI 4
  112. #define I2O_BUS_PCMCIA 5
  113. #define I2O_BUS_NUBUS 6
  114. #define I2O_BUS_CARDBUS 7
  115. #define I2O_BUS_UNKNOWN 0x80
  116. typedef struct _i2o_pci_bus {
  117. __u8 PciFunctionNumber;
  118. __u8 PciDeviceNumber;
  119. __u8 PciBusNumber;
  120. __u8 reserved;
  121. __u16 PciVendorID;
  122. __u16 PciDeviceID;
  123. } i2o_pci_bus;
  124. typedef struct _i2o_local_bus {
  125. __u16 LbBaseIOPort;
  126. __u16 reserved;
  127. __u32 LbBaseMemoryAddress;
  128. } i2o_local_bus;
  129. typedef struct _i2o_isa_bus {
  130. __u16 IsaBaseIOPort;
  131. __u8 CSN;
  132. __u8 reserved;
  133. __u32 IsaBaseMemoryAddress;
  134. } i2o_isa_bus;
  135. typedef struct _i2o_eisa_bus_info {
  136. __u16 EisaBaseIOPort;
  137. __u8 reserved;
  138. __u8 EisaSlotNumber;
  139. __u32 EisaBaseMemoryAddress;
  140. } i2o_eisa_bus;
  141. typedef struct _i2o_mca_bus {
  142. __u16 McaBaseIOPort;
  143. __u8 reserved;
  144. __u8 McaSlotNumber;
  145. __u32 McaBaseMemoryAddress;
  146. } i2o_mca_bus;
  147. typedef struct _i2o_other_bus {
  148. __u16 BaseIOPort;
  149. __u16 reserved;
  150. __u32 BaseMemoryAddress;
  151. } i2o_other_bus;
  152. typedef struct _i2o_hrt_entry {
  153. __u32 adapter_id;
  154. __u32 parent_tid:12;
  155. __u32 state:4;
  156. __u32 bus_num:8;
  157. __u32 bus_type:8;
  158. union {
  159. i2o_pci_bus pci_bus;
  160. i2o_local_bus local_bus;
  161. i2o_isa_bus isa_bus;
  162. i2o_eisa_bus eisa_bus;
  163. i2o_mca_bus mca_bus;
  164. i2o_other_bus other_bus;
  165. } bus;
  166. } i2o_hrt_entry;
  167. typedef struct _i2o_hrt {
  168. __u16 num_entries;
  169. __u8 entry_len;
  170. __u8 hrt_version;
  171. __u32 change_ind;
  172. i2o_hrt_entry hrt_entry[1];
  173. } i2o_hrt;
  174. typedef struct _i2o_lct_entry {
  175. __u32 entry_size:16;
  176. __u32 tid:12;
  177. __u32 reserved:4;
  178. __u32 change_ind;
  179. __u32 device_flags;
  180. __u32 class_id:12;
  181. __u32 version:4;
  182. __u32 vendor_id:16;
  183. __u32 sub_class;
  184. __u32 user_tid:12;
  185. __u32 parent_tid:12;
  186. __u32 bios_info:8;
  187. __u8 identity_tag[8];
  188. __u32 event_capabilities;
  189. } i2o_lct_entry;
  190. typedef struct _i2o_lct {
  191. __u32 table_size:16;
  192. __u32 boot_tid:12;
  193. __u32 lct_ver:4;
  194. __u32 iop_flags;
  195. __u32 change_ind;
  196. i2o_lct_entry lct_entry[1];
  197. } i2o_lct;
  198. typedef struct _i2o_status_block {
  199. __u16 org_id;
  200. __u16 reserved;
  201. __u16 iop_id:12;
  202. __u16 reserved1:4;
  203. __u16 host_unit_id;
  204. __u16 segment_number:12;
  205. __u16 i2o_version:4;
  206. __u8 iop_state;
  207. __u8 msg_type;
  208. __u16 inbound_frame_size;
  209. __u8 init_code;
  210. __u8 reserved2;
  211. __u32 max_inbound_frames;
  212. __u32 cur_inbound_frames;
  213. __u32 max_outbound_frames;
  214. char product_id[24];
  215. __u32 expected_lct_size;
  216. __u32 iop_capabilities;
  217. __u32 desired_mem_size;
  218. __u32 current_mem_size;
  219. __u32 current_mem_base;
  220. __u32 desired_io_size;
  221. __u32 current_io_size;
  222. __u32 current_io_base;
  223. __u32 reserved3:24;
  224. __u32 cmd_status:8;
  225. } i2o_status_block;
  226. /* Event indicator mask flags */
  227. #define I2O_EVT_IND_STATE_CHANGE 0x80000000
  228. #define I2O_EVT_IND_GENERAL_WARNING 0x40000000
  229. #define I2O_EVT_IND_CONFIGURATION_FLAG 0x20000000
  230. #define I2O_EVT_IND_LOCK_RELEASE 0x10000000
  231. #define I2O_EVT_IND_CAPABILITY_CHANGE 0x08000000
  232. #define I2O_EVT_IND_DEVICE_RESET 0x04000000
  233. #define I2O_EVT_IND_EVT_MASK_MODIFIED 0x02000000
  234. #define I2O_EVT_IND_FIELD_MODIFIED 0x01000000
  235. #define I2O_EVT_IND_VENDOR_EVT 0x00800000
  236. #define I2O_EVT_IND_DEVICE_STATE 0x00400000
  237. /* Executive event indicitors */
  238. #define I2O_EVT_IND_EXEC_RESOURCE_LIMITS 0x00000001
  239. #define I2O_EVT_IND_EXEC_CONNECTION_FAIL 0x00000002
  240. #define I2O_EVT_IND_EXEC_ADAPTER_FAULT 0x00000004
  241. #define I2O_EVT_IND_EXEC_POWER_FAIL 0x00000008
  242. #define I2O_EVT_IND_EXEC_RESET_PENDING 0x00000010
  243. #define I2O_EVT_IND_EXEC_RESET_IMMINENT 0x00000020
  244. #define I2O_EVT_IND_EXEC_HW_FAIL 0x00000040
  245. #define I2O_EVT_IND_EXEC_XCT_CHANGE 0x00000080
  246. #define I2O_EVT_IND_EXEC_NEW_LCT_ENTRY 0x00000100
  247. #define I2O_EVT_IND_EXEC_MODIFIED_LCT 0x00000200
  248. #define I2O_EVT_IND_EXEC_DDM_AVAILABILITY 0x00000400
  249. /* Random Block Storage Event Indicators */
  250. #define I2O_EVT_IND_BSA_VOLUME_LOAD 0x00000001
  251. #define I2O_EVT_IND_BSA_VOLUME_UNLOAD 0x00000002
  252. #define I2O_EVT_IND_BSA_VOLUME_UNLOAD_REQ 0x00000004
  253. #define I2O_EVT_IND_BSA_CAPACITY_CHANGE 0x00000008
  254. #define I2O_EVT_IND_BSA_SCSI_SMART 0x00000010
  255. /* Event data for generic events */
  256. #define I2O_EVT_STATE_CHANGE_NORMAL 0x00
  257. #define I2O_EVT_STATE_CHANGE_SUSPENDED 0x01
  258. #define I2O_EVT_STATE_CHANGE_RESTART 0x02
  259. #define I2O_EVT_STATE_CHANGE_NA_RECOVER 0x03
  260. #define I2O_EVT_STATE_CHANGE_NA_NO_RECOVER 0x04
  261. #define I2O_EVT_STATE_CHANGE_QUIESCE_REQUEST 0x05
  262. #define I2O_EVT_STATE_CHANGE_FAILED 0x10
  263. #define I2O_EVT_STATE_CHANGE_FAULTED 0x11
  264. #define I2O_EVT_GEN_WARNING_NORMAL 0x00
  265. #define I2O_EVT_GEN_WARNING_ERROR_THRESHOLD 0x01
  266. #define I2O_EVT_GEN_WARNING_MEDIA_FAULT 0x02
  267. #define I2O_EVT_CAPABILITY_OTHER 0x01
  268. #define I2O_EVT_CAPABILITY_CHANGED 0x02
  269. #define I2O_EVT_SENSOR_STATE_CHANGED 0x01
  270. /*
  271. * I2O classes / subclasses
  272. */
  273. /* Class ID and Code Assignments
  274. * (LCT.ClassID.Version field)
  275. */
  276. #define I2O_CLASS_VERSION_10 0x00
  277. #define I2O_CLASS_VERSION_11 0x01
  278. /* Class code names
  279. * (from v1.5 Table 6-1 Class Code Assignments.)
  280. */
  281. #define I2O_CLASS_EXECUTIVE 0x000
  282. #define I2O_CLASS_DDM 0x001
  283. #define I2O_CLASS_RANDOM_BLOCK_STORAGE 0x010
  284. #define I2O_CLASS_SEQUENTIAL_STORAGE 0x011
  285. #define I2O_CLASS_LAN 0x020
  286. #define I2O_CLASS_WAN 0x030
  287. #define I2O_CLASS_FIBRE_CHANNEL_PORT 0x040
  288. #define I2O_CLASS_FIBRE_CHANNEL_PERIPHERAL 0x041
  289. #define I2O_CLASS_SCSI_PERIPHERAL 0x051
  290. #define I2O_CLASS_ATE_PORT 0x060
  291. #define I2O_CLASS_ATE_PERIPHERAL 0x061
  292. #define I2O_CLASS_FLOPPY_CONTROLLER 0x070
  293. #define I2O_CLASS_FLOPPY_DEVICE 0x071
  294. #define I2O_CLASS_BUS_ADAPTER 0x080
  295. #define I2O_CLASS_PEER_TRANSPORT_AGENT 0x090
  296. #define I2O_CLASS_PEER_TRANSPORT 0x091
  297. #define I2O_CLASS_END 0xfff
  298. /*
  299. * Rest of 0x092 - 0x09f reserved for peer-to-peer classes
  300. */
  301. #define I2O_CLASS_MATCH_ANYCLASS 0xffffffff
  302. /*
  303. * Subclasses
  304. */
  305. #define I2O_SUBCLASS_i960 0x001
  306. #define I2O_SUBCLASS_HDM 0x020
  307. #define I2O_SUBCLASS_ISM 0x021
  308. /* Operation functions */
  309. #define I2O_PARAMS_FIELD_GET 0x0001
  310. #define I2O_PARAMS_LIST_GET 0x0002
  311. #define I2O_PARAMS_MORE_GET 0x0003
  312. #define I2O_PARAMS_SIZE_GET 0x0004
  313. #define I2O_PARAMS_TABLE_GET 0x0005
  314. #define I2O_PARAMS_FIELD_SET 0x0006
  315. #define I2O_PARAMS_LIST_SET 0x0007
  316. #define I2O_PARAMS_ROW_ADD 0x0008
  317. #define I2O_PARAMS_ROW_DELETE 0x0009
  318. #define I2O_PARAMS_TABLE_CLEAR 0x000A
  319. /*
  320. * I2O serial number conventions / formats
  321. * (circa v1.5)
  322. */
  323. #define I2O_SNFORMAT_UNKNOWN 0
  324. #define I2O_SNFORMAT_BINARY 1
  325. #define I2O_SNFORMAT_ASCII 2
  326. #define I2O_SNFORMAT_UNICODE 3
  327. #define I2O_SNFORMAT_LAN48_MAC 4
  328. #define I2O_SNFORMAT_WAN 5
  329. /*
  330. * Plus new in v2.0 (Yellowstone pdf doc)
  331. */
  332. #define I2O_SNFORMAT_LAN64_MAC 6
  333. #define I2O_SNFORMAT_DDM 7
  334. #define I2O_SNFORMAT_IEEE_REG64 8
  335. #define I2O_SNFORMAT_IEEE_REG128 9
  336. #define I2O_SNFORMAT_UNKNOWN2 0xff
  337. /*
  338. * I2O Get Status State values
  339. */
  340. #define ADAPTER_STATE_INITIALIZING 0x01
  341. #define ADAPTER_STATE_RESET 0x02
  342. #define ADAPTER_STATE_HOLD 0x04
  343. #define ADAPTER_STATE_READY 0x05
  344. #define ADAPTER_STATE_OPERATIONAL 0x08
  345. #define ADAPTER_STATE_FAILED 0x10
  346. #define ADAPTER_STATE_FAULTED 0x11
  347. /*
  348. * Software module types
  349. */
  350. #define I2O_SOFTWARE_MODULE_IRTOS 0x11
  351. #define I2O_SOFTWARE_MODULE_IOP_PRIVATE 0x22
  352. #define I2O_SOFTWARE_MODULE_IOP_CONFIG 0x23
  353. /*
  354. * Vendors
  355. */
  356. #define I2O_VENDOR_DPT 0x001b
  357. /*
  358. * DPT / Adaptec specific values for i2o_sg_io_hdr flags.
  359. */
  360. #define I2O_DPT_SG_FLAG_INTERPRET 0x00010000
  361. #define I2O_DPT_SG_FLAG_PHYSICAL 0x00020000
  362. #define I2O_DPT_FLASH_FRAG_SIZE 0x10000
  363. #define I2O_DPT_FLASH_READ 0x0101
  364. #define I2O_DPT_FLASH_WRITE 0x0102
  365. #endif /* _I2O_DEV_H */