PageRenderTime 74ms CodeModel.GetById 14ms RepoModel.GetById 1ms app.codeStats 0ms

/drivers/scsi/bfa/include/bfa.h

https://bitbucket.org/abioy/linux
C Header | 199 lines | 138 code | 24 blank | 37 comment | 1 complexity | b3c16569064e55a3ad9a98658c6cc8bd MD5 | raw file
Possible License(s): CC-BY-SA-3.0, GPL-2.0, LGPL-2.0, AGPL-1.0 
    

  1. /*
    2. 

  2.  * Copyright (c) 2005-2009 Brocade Communications Systems, Inc.
    3. 

  3.  * All rights reserved
    4. 

  4.  * www.brocade.com
    5. 

  5.  *
    6. 

  6.  * Linux driver for Brocade Fibre Channel Host Bus Adapter.
    7. 

  7.  *
    8. 

  8.  * This program is free software; you can redistribute it and/or modify it
    9. 

  9.  * under the terms of the GNU General Public License (GPL) Version 2 as
    10. 

  10.  * published by the Free Software Foundation
    11. 

  11.  *
    12. 

  12.  * This program is distributed in the hope that it will be useful, but
    13. 

  13.  * WITHOUT ANY WARRANTY; without even the implied warranty of
    14. 

  14.  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    15. 

  15.  * General Public License for more details.
    16. 

  16.  */
    17. 

  17. #ifndef __BFA_H__
    18. 

  18. #define __BFA_H__
    19. 

  19. 

  20. #include <bfa_os_inc.h>
    21. 

  21. #include <cs/bfa_debug.h>
    22. 

  22. #include <cs/bfa_q.h>
    23. 

  23. #include <cs/bfa_trc.h>
    24. 

  24. #include <cs/bfa_log.h>
    25. 

  25. #include <cs/bfa_plog.h>
    26. 

  26. #include <defs/bfa_defs_status.h>
    27. 

  27. #include <defs/bfa_defs_ioc.h>
    28. 

  28. #include <defs/bfa_defs_iocfc.h>
    29. 

  29. #include <aen/bfa_aen.h>
    30. 

  30. #include <bfi/bfi.h>
    31. 

  31. 

  32. struct bfa_s;
    33. 

  33. #include <bfa_intr_priv.h>
    34. 

  34. 

  35. struct bfa_pcidev_s;
    36. 

  36. 

  37. /**
    38. 

  38.  * PCI devices supported by the current BFA
    39. 

  39.  */
    40. 

  40. struct bfa_pciid_s {
    41. 

  41. 	u16        device_id;
    42. 

  42. 	u16        vendor_id;
    43. 

  43. };
    44. 

  44. 

  45. extern char     bfa_version[];
    46. 

  46. 

  47. /**
    48. 

  48.  * BFA Power Mgmt Commands
    49. 

  49.  */
    50. 

  50. enum bfa_pm_cmd {
    51. 

  51. 	BFA_PM_CTL_D0 = 0,
    52. 

  52. 	BFA_PM_CTL_D1 = 1,
    53. 

  53. 	BFA_PM_CTL_D2 = 2,
    54. 

  54. 	BFA_PM_CTL_D3 = 3,
    55. 

  55. };
    56. 

  56. 

  57. /**
    58. 

  58.  * BFA memory resources
    59. 

  59.  */
    60. 

  60. enum bfa_mem_type {
    61. 

  61. 	BFA_MEM_TYPE_KVA = 1,	/*! Kernel Virtual Memory *(non-dma-able) */
    62. 

  62. 	BFA_MEM_TYPE_DMA = 2,	/*! DMA-able memory */
    63. 

  63. 	BFA_MEM_TYPE_MAX = BFA_MEM_TYPE_DMA,
    64. 

  64. };
    65. 

  65. 

  66. struct bfa_mem_elem_s {
    67. 

  67. 	enum bfa_mem_type mem_type;	/*  see enum bfa_mem_type 	*/
    68. 

  68. 	u32        mem_len;	/*  Total Length in Bytes	*/
    69. 

  69. 	u8       	*kva;		/*  kernel virtual address	*/
    70. 

  70. 	u64        dma;		/*  dma address if DMA memory	*/
    71. 

  71. 	u8       	*kva_curp;	/*  kva allocation cursor	*/
    72. 

  72. 	u64        dma_curp;	/*  dma allocation cursor	*/
    73. 

  73. };
    74. 

  74. 

  75. struct bfa_meminfo_s {
    76. 

  76. 	struct bfa_mem_elem_s meminfo[BFA_MEM_TYPE_MAX];
    77. 

  77. };
    78. 

  78. #define bfa_meminfo_kva(_m)	\
    79. 

  79. 	((_m)->meminfo[BFA_MEM_TYPE_KVA - 1].kva_curp)
    80. 

  80. #define bfa_meminfo_dma_virt(_m)	\
    81. 

  81. 	((_m)->meminfo[BFA_MEM_TYPE_DMA - 1].kva_curp)
    82. 

  82. #define bfa_meminfo_dma_phys(_m)	\
    83. 

  83. 	((_m)->meminfo[BFA_MEM_TYPE_DMA - 1].dma_curp)
    84. 

  84. 

  85. /**
    86. 

  86.  * Generic Scatter Gather Element used by driver
    87. 

  87.  */
    88. 

  88. struct bfa_sge_s {
    89. 

  89. 	u32        sg_len;
    90. 

  90. 	void           *sg_addr;
    91. 

  91. };
    92. 

  92. 

  93. #define bfa_sge_to_be(__sge) do {                                          \
    94. 

  94. 	((u32 *)(__sge))[0] = bfa_os_htonl(((u32 *)(__sge))[0]);      \
    95. 

  95. 	((u32 *)(__sge))[1] = bfa_os_htonl(((u32 *)(__sge))[1]);      \
    96. 

  96. 	((u32 *)(__sge))[2] = bfa_os_htonl(((u32 *)(__sge))[2]);      \
    97. 

  97. } while (0)
    98. 

  98. 

  99. 

  100. /*
    101. 

  101.  * bfa stats interfaces
    102. 

  102.  */
    103. 

  103. #define bfa_stats(_mod, _stats)	((_mod)->stats._stats++)
    104. 

  104. 

  105. #define bfa_ioc_get_stats(__bfa, __ioc_stats)	\
    106. 

  106. 	bfa_ioc_fetch_stats(&(__bfa)->ioc, __ioc_stats)
    107. 

  107. #define bfa_ioc_clear_stats(__bfa)	\
    108. 

  108. 	bfa_ioc_clr_stats(&(__bfa)->ioc)
    109. 

  109. #define bfa_get_nports(__bfa)   \
    110. 

  110. 	bfa_ioc_get_nports(&(__bfa)->ioc)
    111. 

  111. #define bfa_get_adapter_manufacturer(__bfa, __manufacturer) \
    112. 

  112. 	bfa_ioc_get_adapter_manufacturer(&(__bfa)->ioc, __manufacturer)
    113. 

  113. #define bfa_get_adapter_model(__bfa, __model)   \
    114. 

  114. 	bfa_ioc_get_adapter_model(&(__bfa)->ioc, __model)
    115. 

  115. #define bfa_get_adapter_serial_num(__bfa, __serial_num) \
    116. 

  116. 	bfa_ioc_get_adapter_serial_num(&(__bfa)->ioc, __serial_num)
    117. 

  117. #define bfa_get_adapter_fw_ver(__bfa, __fw_ver) \
    118. 

  118. 	bfa_ioc_get_adapter_fw_ver(&(__bfa)->ioc, __fw_ver)
    119. 

  119. #define bfa_get_adapter_optrom_ver(__bfa, __optrom_ver) \
    120. 

  120. 	bfa_ioc_get_adapter_optrom_ver(&(__bfa)->ioc, __optrom_ver)
    121. 

  121. #define bfa_get_pci_chip_rev(__bfa, __chip_rev) \
    122. 

  122. 	bfa_ioc_get_pci_chip_rev(&(__bfa)->ioc, __chip_rev)
    123. 

  123. #define bfa_get_ioc_state(__bfa)    \
    124. 

  124. 	bfa_ioc_get_state(&(__bfa)->ioc)
    125. 

  125. #define bfa_get_type(__bfa) \
    126. 

  126. 	bfa_ioc_get_type(&(__bfa)->ioc)
    127. 

  127. #define bfa_get_mac(__bfa)  \
    128. 

  128. 	bfa_ioc_get_mac(&(__bfa)->ioc)
    129. 

  129. 

  130. /*
    131. 

  131.  * bfa API functions
    132. 

  132.  */
    133. 

  133. void bfa_get_pciids(struct bfa_pciid_s **pciids, int *npciids);
    134. 

  134. void bfa_cfg_get_default(struct bfa_iocfc_cfg_s *cfg);
    135. 

  135. void bfa_cfg_get_min(struct bfa_iocfc_cfg_s *cfg);
    136. 

  136. void bfa_cfg_get_meminfo(struct bfa_iocfc_cfg_s *cfg,
    137. 

  137. 			struct bfa_meminfo_s *meminfo);
    138. 

  138. void bfa_attach(struct bfa_s *bfa, void *bfad, struct bfa_iocfc_cfg_s *cfg,
    139. 

  139. 			struct bfa_meminfo_s *meminfo,
    140. 

  140. 			struct bfa_pcidev_s *pcidev);
    141. 

  141. void bfa_init_trc(struct bfa_s *bfa, struct bfa_trc_mod_s *trcmod);
    142. 

  142. void bfa_init_log(struct bfa_s *bfa, struct bfa_log_mod_s *logmod);
    143. 

  143. void bfa_init_aen(struct bfa_s *bfa, struct bfa_aen_s *aen);
    144. 

  144. void bfa_init_plog(struct bfa_s *bfa, struct bfa_plog_s *plog);
    145. 

  145. void bfa_detach(struct bfa_s *bfa);
    146. 

  146. void bfa_init(struct bfa_s *bfa);
    147. 

  147. void bfa_start(struct bfa_s *bfa);
    148. 

  148. void bfa_stop(struct bfa_s *bfa);
    149. 

  149. void bfa_attach_fcs(struct bfa_s *bfa);
    150. 

  150. void bfa_cb_init(void *bfad, bfa_status_t status);
    151. 

  151. void bfa_cb_stop(void *bfad, bfa_status_t status);
    152. 

  152. void bfa_cb_updateq(void *bfad, bfa_status_t status);
    153. 

  153. 

  154. bfa_boolean_t bfa_intx(struct bfa_s *bfa);
    155. 

  155. void bfa_isr_enable(struct bfa_s *bfa);
    156. 

  156. void bfa_isr_disable(struct bfa_s *bfa);
    157. 

  157. void bfa_msix_getvecs(struct bfa_s *bfa, u32 *msix_vecs_bmap,
    158. 

  158. 			u32 *num_vecs, u32 *max_vec_bit);
    159. 

  159. #define bfa_msix(__bfa, __vec) ((__bfa)->msix.handler[__vec](__bfa, __vec))
    160. 

  160. 

  161. void bfa_comp_deq(struct bfa_s *bfa, struct list_head *comp_q);
    162. 

  162. void bfa_comp_process(struct bfa_s *bfa, struct list_head *comp_q);
    163. 

  163. void bfa_comp_free(struct bfa_s *bfa, struct list_head *comp_q);
    164. 

  164. 

  165. typedef void (*bfa_cb_ioc_t) (void *cbarg, enum bfa_status status);
    166. 

  166. void bfa_iocfc_get_attr(struct bfa_s *bfa, struct bfa_iocfc_attr_s *attr);
    167. 

  167. bfa_status_t bfa_iocfc_get_stats(struct bfa_s *bfa,
    168. 

  168. 			struct bfa_iocfc_stats_s *stats,
    169. 

  169. 			bfa_cb_ioc_t cbfn, void *cbarg);
    170. 

  170. bfa_status_t bfa_iocfc_clear_stats(struct bfa_s *bfa,
    171. 

  171. 			bfa_cb_ioc_t cbfn, void *cbarg);
    172. 

  172. void bfa_get_attr(struct bfa_s *bfa, struct bfa_ioc_attr_s *ioc_attr);
    173. 

  173. 

  174. void bfa_adapter_get_attr(struct bfa_s *bfa,
    175. 

  175. 			struct bfa_adapter_attr_s *ad_attr);
    176. 

  176. u64 bfa_adapter_get_id(struct bfa_s *bfa);
    177. 

  177. 

  178. bfa_status_t bfa_iocfc_israttr_set(struct bfa_s *bfa,
    179. 

  179. 			struct bfa_iocfc_intr_attr_s *attr);
    180. 

  180. 

  181. void bfa_iocfc_enable(struct bfa_s *bfa);
    182. 

  182. void bfa_iocfc_disable(struct bfa_s *bfa);
    183. 

  183. void bfa_ioc_auto_recover(bfa_boolean_t auto_recover);
    184. 

  184. void bfa_chip_reset(struct bfa_s *bfa);
    185. 

  185. void bfa_cb_ioc_disable(void *bfad);
    186. 

  186. void bfa_timer_tick(struct bfa_s *bfa);
    187. 

  187. #define bfa_timer_start(_bfa, _timer, _timercb, _arg, _timeout)	\
    188. 

  188. 	bfa_timer_begin(&(_bfa)->timer_mod, _timer, _timercb, _arg, _timeout)
    189. 

  189. 

  190. /*
    191. 

  191.  * BFA debug API functions
    192. 

  192.  */
    193. 

  193. bfa_status_t bfa_debug_fwtrc(struct bfa_s *bfa, void *trcdata, int *trclen);
    194. 

  194. bfa_status_t bfa_debug_fwsave(struct bfa_s *bfa, void *trcdata, int *trclen);
    195. 

  195. void bfa_debug_fwsave_clear(struct bfa_s *bfa);
    196. 

  196. 

  197. #include "bfa_priv.h"
    198. 

  198. 

  199. #endif /* __BFA_H__ */
    200. 

  200.