megaraid_mbox.h 7.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232
  1. /* SPDX-License-Identifier: GPL-2.0-or-later */
  2. /*
  3. *
  4. * Linux MegaRAID device driver
  5. *
  6. * Copyright (c) 2003-2004 LSI Logic Corporation.
  7. *
  8. * FILE : megaraid_mbox.h
  9. */
  10. #ifndef _MEGARAID_H_
  11. #define _MEGARAID_H_
  12. #include "mega_common.h"
  13. #include "mbox_defs.h"
  14. #include "megaraid_ioctl.h"
  15. #define MEGARAID_VERSION "2.20.5.1"
  16. #define MEGARAID_EXT_VERSION "(Release Date: Thu Nov 16 15:32:35 EST 2006)"
  17. /*
  18. * Define some PCI values here until they are put in the kernel
  19. */
  20. #define PCI_DEVICE_ID_PERC4_DI_DISCOVERY 0x000E
  21. #define PCI_SUBSYS_ID_PERC4_DI_DISCOVERY 0x0123
  22. #define PCI_DEVICE_ID_PERC4_SC 0x1960
  23. #define PCI_SUBSYS_ID_PERC4_SC 0x0520
  24. #define PCI_DEVICE_ID_PERC4_DC 0x1960
  25. #define PCI_SUBSYS_ID_PERC4_DC 0x0518
  26. #define PCI_DEVICE_ID_VERDE 0x0407
  27. #define PCI_DEVICE_ID_PERC4_DI_EVERGLADES 0x000F
  28. #define PCI_SUBSYS_ID_PERC4_DI_EVERGLADES 0x014A
  29. #define PCI_DEVICE_ID_PERC4E_SI_BIGBEND 0x0013
  30. #define PCI_SUBSYS_ID_PERC4E_SI_BIGBEND 0x016c
  31. #define PCI_DEVICE_ID_PERC4E_DI_KOBUK 0x0013
  32. #define PCI_SUBSYS_ID_PERC4E_DI_KOBUK 0x016d
  33. #define PCI_DEVICE_ID_PERC4E_DI_CORVETTE 0x0013
  34. #define PCI_SUBSYS_ID_PERC4E_DI_CORVETTE 0x016e
  35. #define PCI_DEVICE_ID_PERC4E_DI_EXPEDITION 0x0013
  36. #define PCI_SUBSYS_ID_PERC4E_DI_EXPEDITION 0x016f
  37. #define PCI_DEVICE_ID_PERC4E_DI_GUADALUPE 0x0013
  38. #define PCI_SUBSYS_ID_PERC4E_DI_GUADALUPE 0x0170
  39. #define PCI_DEVICE_ID_DOBSON 0x0408
  40. #define PCI_DEVICE_ID_MEGARAID_SCSI_320_0 0x1960
  41. #define PCI_SUBSYS_ID_MEGARAID_SCSI_320_0 0xA520
  42. #define PCI_DEVICE_ID_MEGARAID_SCSI_320_1 0x1960
  43. #define PCI_SUBSYS_ID_MEGARAID_SCSI_320_1 0x0520
  44. #define PCI_DEVICE_ID_MEGARAID_SCSI_320_2 0x1960
  45. #define PCI_SUBSYS_ID_MEGARAID_SCSI_320_2 0x0518
  46. #define PCI_DEVICE_ID_MEGARAID_I4_133_RAID 0x1960
  47. #define PCI_SUBSYS_ID_MEGARAID_I4_133_RAID 0x0522
  48. #define PCI_DEVICE_ID_MEGARAID_SATA_150_4 0x1960
  49. #define PCI_SUBSYS_ID_MEGARAID_SATA_150_4 0x4523
  50. #define PCI_DEVICE_ID_MEGARAID_SATA_150_6 0x1960
  51. #define PCI_SUBSYS_ID_MEGARAID_SATA_150_6 0x0523
  52. #define PCI_DEVICE_ID_LINDSAY 0x0409
  53. #define PCI_DEVICE_ID_INTEL_RAID_SRCS16 0x1960
  54. #define PCI_SUBSYS_ID_INTEL_RAID_SRCS16 0x0523
  55. #define PCI_DEVICE_ID_INTEL_RAID_SRCU41L_LAKE_SHETEK 0x1960
  56. #define PCI_SUBSYS_ID_INTEL_RAID_SRCU41L_LAKE_SHETEK 0x0520
  57. #define PCI_SUBSYS_ID_PERC3_QC 0x0471
  58. #define PCI_SUBSYS_ID_PERC3_DC 0x0493
  59. #define PCI_SUBSYS_ID_PERC3_SC 0x0475
  60. #define PCI_SUBSYS_ID_CERC_ATA100_4CH 0x0511
  61. #define MBOX_MAX_SCSI_CMDS 128 // number of cmds reserved for kernel
  62. #define MBOX_MAX_USER_CMDS 32 // number of cmds for applications
  63. #define MBOX_DEF_CMD_PER_LUN 64 // default commands per lun
  64. #define MBOX_DEFAULT_SG_SIZE 26 // default sg size supported by all fw
  65. #define MBOX_MAX_SG_SIZE 32 // maximum scatter-gather list size
  66. #define MBOX_MAX_SECTORS 128 // maximum sectors per IO
  67. #define MBOX_TIMEOUT 30 // timeout value for internal cmds
  68. #define MBOX_BUSY_WAIT 10 // max usec to wait for busy mailbox
  69. #define MBOX_RESET_WAIT 180 // wait these many seconds in reset
  70. #define MBOX_RESET_EXT_WAIT 120 // extended wait reset
  71. #define MBOX_SYNC_WAIT_CNT 0xFFFF // wait loop index for synchronous mode
  72. #define MBOX_SYNC_DELAY_200 200 // 200 micro-seconds
  73. /*
  74. * maximum transfer that can happen through the firmware commands issued
  75. * internnaly from the driver.
  76. */
  77. #define MBOX_IBUF_SIZE 4096
  78. /**
  79. * mbox_ccb_t - command control block specific to mailbox based controllers
  80. * @raw_mbox : raw mailbox pointer
  81. * @mbox : mailbox
  82. * @mbox64 : extended mailbox
  83. * @mbox_dma_h : mailbox dma address
  84. * @sgl64 : 64-bit scatter-gather list
  85. * @sgl32 : 32-bit scatter-gather list
  86. * @sgl_dma_h : dma handle for the scatter-gather list
  87. * @pthru : passthru structure
  88. * @pthru_dma_h : dma handle for the passthru structure
  89. * @epthru : extended passthru structure
  90. * @epthru_dma_h : dma handle for extended passthru structure
  91. * @buf_dma_h : dma handle for buffers w/o sg list
  92. *
  93. * command control block specific to the mailbox based controllers
  94. */
  95. typedef struct {
  96. uint8_t *raw_mbox;
  97. mbox_t *mbox;
  98. mbox64_t *mbox64;
  99. dma_addr_t mbox_dma_h;
  100. mbox_sgl64 *sgl64;
  101. mbox_sgl32 *sgl32;
  102. dma_addr_t sgl_dma_h;
  103. mraid_passthru_t *pthru;
  104. dma_addr_t pthru_dma_h;
  105. mraid_epassthru_t *epthru;
  106. dma_addr_t epthru_dma_h;
  107. dma_addr_t buf_dma_h;
  108. } mbox_ccb_t;
  109. /**
  110. * mraid_device_t - adapter soft state structure for mailbox controllers
  111. * @una_mbox64 : 64-bit mbox - unaligned
  112. * @una_mbox64_dma : mbox dma addr - unaligned
  113. * @mbox : 32-bit mbox - aligned
  114. * @mbox64 : 64-bit mbox - aligned
  115. * @mbox_dma : mbox dma addr - aligned
  116. * @mailbox_lock : exclusion lock for the mailbox
  117. * @baseport : base port of hba memory
  118. * @baseaddr : mapped addr of hba memory
  119. * @mbox_pool : pool of mailboxes
  120. * @mbox_pool_handle : handle for the mailbox pool memory
  121. * @epthru_pool : a pool for extended passthru commands
  122. * @epthru_pool_handle : handle to the pool above
  123. * @sg_pool : pool of scatter-gather lists for this driver
  124. * @sg_pool_handle : handle to the pool above
  125. * @ccb_list : list of our command control blocks
  126. * @uccb_list : list of cmd control blocks for mgmt module
  127. * @umbox64 : array of mailbox for user commands (cmm)
  128. * @pdrv_state : array for state of each physical drive.
  129. * @last_disp : flag used to show device scanning
  130. * @hw_error : set if FW not responding
  131. * @fast_load : If set, skip physical device scanning
  132. * @channel_class : channel class, RAID or SCSI
  133. * @sysfs_mtx : mutex to serialize access to sysfs res.
  134. * @sysfs_uioc : management packet to issue FW calls from sysfs
  135. * @sysfs_mbox64 : mailbox packet to issue FW calls from sysfs
  136. * @sysfs_buffer : data buffer for FW commands issued from sysfs
  137. * @sysfs_buffer_dma : DMA buffer for FW commands issued from sysfs
  138. * @sysfs_wait_q : wait queue for sysfs operations
  139. * @random_del_supported : set if the random deletion is supported
  140. * @curr_ldmap : current LDID map
  141. *
  142. * Initialization structure for mailbox controllers: memory based and IO based
  143. * All the fields in this structure are LLD specific and may be discovered at
  144. * init() or start() time.
  145. *
  146. * NOTE: The fields of this structures are placed to minimize cache misses
  147. */
  148. #define MAX_LD_EXTENDED64 64
  149. typedef struct {
  150. mbox64_t *una_mbox64;
  151. dma_addr_t una_mbox64_dma;
  152. mbox_t *mbox;
  153. mbox64_t *mbox64;
  154. dma_addr_t mbox_dma;
  155. spinlock_t mailbox_lock;
  156. unsigned long baseport;
  157. void __iomem * baseaddr;
  158. struct mraid_pci_blk mbox_pool[MBOX_MAX_SCSI_CMDS];
  159. struct dma_pool *mbox_pool_handle;
  160. struct mraid_pci_blk epthru_pool[MBOX_MAX_SCSI_CMDS];
  161. struct dma_pool *epthru_pool_handle;
  162. struct mraid_pci_blk sg_pool[MBOX_MAX_SCSI_CMDS];
  163. struct dma_pool *sg_pool_handle;
  164. mbox_ccb_t ccb_list[MBOX_MAX_SCSI_CMDS];
  165. mbox_ccb_t uccb_list[MBOX_MAX_USER_CMDS];
  166. mbox64_t umbox64[MBOX_MAX_USER_CMDS];
  167. uint8_t pdrv_state[MBOX_MAX_PHYSICAL_DRIVES];
  168. uint32_t last_disp;
  169. int hw_error;
  170. int fast_load;
  171. uint8_t channel_class;
  172. struct mutex sysfs_mtx;
  173. uioc_t *sysfs_uioc;
  174. mbox64_t *sysfs_mbox64;
  175. caddr_t sysfs_buffer;
  176. dma_addr_t sysfs_buffer_dma;
  177. wait_queue_head_t sysfs_wait_q;
  178. int random_del_supported;
  179. uint16_t curr_ldmap[MAX_LD_EXTENDED64];
  180. } mraid_device_t;
  181. // route to raid device from adapter
  182. #define ADAP2RAIDDEV(adp) ((mraid_device_t *)((adp)->raid_device))
  183. #define MAILBOX_LOCK(rdev) (&(rdev)->mailbox_lock)
  184. // Find out if this channel is a RAID or SCSI
  185. #define IS_RAID_CH(rdev, ch) (((rdev)->channel_class >> (ch)) & 0x01)
  186. #define RDINDOOR(rdev) readl((rdev)->baseaddr + 0x20)
  187. #define RDOUTDOOR(rdev) readl((rdev)->baseaddr + 0x2C)
  188. #define WRINDOOR(rdev, value) writel(value, (rdev)->baseaddr + 0x20)
  189. #define WROUTDOOR(rdev, value) writel(value, (rdev)->baseaddr + 0x2C)
  190. #endif // _MEGARAID_H_