sym_fw.h 5.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192
  1. /* SPDX-License-Identifier: GPL-2.0-or-later */
  2. /*
  3. * Device driver for the SYMBIOS/LSILOGIC 53C8XX and 53C1010 family
  4. * of PCI-SCSI IO processors.
  5. *
  6. * Copyright (C) 1999-2001 Gerard Roudier <groudier@free.fr>
  7. *
  8. * This driver is derived from the Linux sym53c8xx driver.
  9. * Copyright (C) 1998-2000 Gerard Roudier
  10. *
  11. * The sym53c8xx driver is derived from the ncr53c8xx driver that had been
  12. * a port of the FreeBSD ncr driver to Linux-1.2.13.
  13. *
  14. * The original ncr driver has been written for 386bsd and FreeBSD by
  15. * Wolfgang Stanglmeier <wolf@cologne.de>
  16. * Stefan Esser <se@mi.Uni-Koeln.de>
  17. * Copyright (C) 1994 Wolfgang Stanglmeier
  18. *
  19. * Other major contributions:
  20. *
  21. * NVRAM detection and reading.
  22. * Copyright (C) 1997 Richard Waltham <dormouse@farsrobt.demon.co.uk>
  23. *
  24. *-----------------------------------------------------------------------------
  25. */
  26. #ifndef SYM_FW_H
  27. #define SYM_FW_H
  28. /*
  29. * Macro used to generate interfaces for script A.
  30. */
  31. #define SYM_GEN_FW_A(s) \
  32. SYM_GEN_A(s, start) SYM_GEN_A(s, getjob_begin) \
  33. SYM_GEN_A(s, getjob_end) \
  34. SYM_GEN_A(s, select) SYM_GEN_A(s, wf_sel_done) \
  35. SYM_GEN_A(s, send_ident) \
  36. SYM_GEN_A(s, dispatch) SYM_GEN_A(s, init) \
  37. SYM_GEN_A(s, clrack) SYM_GEN_A(s, complete_error) \
  38. SYM_GEN_A(s, done) SYM_GEN_A(s, done_end) \
  39. SYM_GEN_A(s, idle) SYM_GEN_A(s, ungetjob) \
  40. SYM_GEN_A(s, reselect) \
  41. SYM_GEN_A(s, resel_tag) SYM_GEN_A(s, resel_dsa) \
  42. SYM_GEN_A(s, resel_no_tag) \
  43. SYM_GEN_A(s, data_in) SYM_GEN_A(s, data_in2) \
  44. SYM_GEN_A(s, data_out) SYM_GEN_A(s, data_out2) \
  45. SYM_GEN_A(s, pm0_data) SYM_GEN_A(s, pm1_data)
  46. /*
  47. * Macro used to generate interfaces for script B.
  48. */
  49. #define SYM_GEN_FW_B(s) \
  50. SYM_GEN_B(s, no_data) \
  51. SYM_GEN_B(s, sel_for_abort) SYM_GEN_B(s, sel_for_abort_1) \
  52. SYM_GEN_B(s, msg_bad) SYM_GEN_B(s, msg_weird) \
  53. SYM_GEN_B(s, wdtr_resp) SYM_GEN_B(s, send_wdtr) \
  54. SYM_GEN_B(s, sdtr_resp) SYM_GEN_B(s, send_sdtr) \
  55. SYM_GEN_B(s, ppr_resp) SYM_GEN_B(s, send_ppr) \
  56. SYM_GEN_B(s, nego_bad_phase) \
  57. SYM_GEN_B(s, ident_break) SYM_GEN_B(s, ident_break_atn) \
  58. SYM_GEN_B(s, sdata_in) SYM_GEN_B(s, resel_bad_lun) \
  59. SYM_GEN_B(s, bad_i_t_l) SYM_GEN_B(s, bad_i_t_l_q) \
  60. SYM_GEN_B(s, wsr_ma_helper)
  61. /*
  62. * Macro used to generate interfaces for script Z.
  63. */
  64. #define SYM_GEN_FW_Z(s) \
  65. SYM_GEN_Z(s, snooptest) SYM_GEN_Z(s, snoopend)
  66. /*
  67. * Generates structure interface that contains
  68. * offsets within script A, B and Z.
  69. */
  70. #define SYM_GEN_A(s, label) s label;
  71. #define SYM_GEN_B(s, label) s label;
  72. #define SYM_GEN_Z(s, label) s label;
  73. struct sym_fwa_ofs {
  74. SYM_GEN_FW_A(u_short)
  75. };
  76. struct sym_fwb_ofs {
  77. SYM_GEN_FW_B(u_short)
  78. SYM_GEN_B(u_short, start64)
  79. SYM_GEN_B(u_short, pm_handle)
  80. };
  81. struct sym_fwz_ofs {
  82. SYM_GEN_FW_Z(u_short)
  83. };
  84. /*
  85. * Generates structure interface that contains
  86. * bus addresses within script A, B and Z.
  87. */
  88. struct sym_fwa_ba {
  89. SYM_GEN_FW_A(u32)
  90. };
  91. struct sym_fwb_ba {
  92. SYM_GEN_FW_B(u32)
  93. SYM_GEN_B(u32, start64);
  94. SYM_GEN_B(u32, pm_handle);
  95. };
  96. struct sym_fwz_ba {
  97. SYM_GEN_FW_Z(u32)
  98. };
  99. #undef SYM_GEN_A
  100. #undef SYM_GEN_B
  101. #undef SYM_GEN_Z
  102. /*
  103. * Let cc know about the name of the controller data structure.
  104. * We need this for function prototype declarations just below.
  105. */
  106. struct sym_hcb;
  107. /*
  108. * Generic structure that defines a firmware.
  109. */
  110. struct sym_fw {
  111. char *name; /* Name we want to print out */
  112. u32 *a_base; /* Pointer to script A template */
  113. int a_size; /* Size of script A */
  114. struct sym_fwa_ofs
  115. *a_ofs; /* Useful offsets in script A */
  116. u32 *b_base; /* Pointer to script B template */
  117. int b_size; /* Size of script B */
  118. struct sym_fwb_ofs
  119. *b_ofs; /* Useful offsets in script B */
  120. u32 *z_base; /* Pointer to script Z template */
  121. int z_size; /* Size of script Z */
  122. struct sym_fwz_ofs
  123. *z_ofs; /* Useful offsets in script Z */
  124. /* Setup and patch methods for this firmware */
  125. void (*setup)(struct sym_hcb *, struct sym_fw *);
  126. void (*patch)(struct Scsi_Host *);
  127. };
  128. /*
  129. * Macro used to declare a firmware.
  130. */
  131. #define SYM_FW_ENTRY(fw, name) \
  132. { \
  133. name, \
  134. (u32 *) &fw##a_scr, sizeof(fw##a_scr), &fw##a_ofs, \
  135. (u32 *) &fw##b_scr, sizeof(fw##b_scr), &fw##b_ofs, \
  136. (u32 *) &fw##z_scr, sizeof(fw##z_scr), &fw##z_ofs, \
  137. fw##_setup, fw##_patch \
  138. }
  139. /*
  140. * Macros used from the C code to get useful
  141. * SCRIPTS bus addresses.
  142. */
  143. #define SCRIPTA_BA(np, label) (np->fwa_bas.label)
  144. #define SCRIPTB_BA(np, label) (np->fwb_bas.label)
  145. #define SCRIPTZ_BA(np, label) (np->fwz_bas.label)
  146. /*
  147. * Macros used by scripts definitions.
  148. *
  149. * HADDR_1 generates a reference to a field of the controller data.
  150. * HADDR_2 generates a reference to a field of the controller data
  151. * with offset.
  152. * RADDR_1 generates a reference to a script processor register.
  153. * RADDR_2 generates a reference to a script processor register
  154. * with offset.
  155. * PADDR_A generates a reference to another part of script A.
  156. * PADDR_B generates a reference to another part of script B.
  157. *
  158. * SYM_GEN_PADDR_A and SYM_GEN_PADDR_B are used to define respectively
  159. * the PADDR_A and PADDR_B macros for each firmware by setting argument
  160. * `s' to the name of the corresponding structure.
  161. *
  162. * SCR_DATA_ZERO is used to allocate a DWORD of data in scripts areas.
  163. */
  164. #define RELOC_SOFTC 0x40000000
  165. #define RELOC_LABEL_A 0x50000000
  166. #define RELOC_REGISTER 0x60000000
  167. #define RELOC_LABEL_B 0x80000000
  168. #define RELOC_MASK 0xf0000000
  169. #define HADDR_1(label) (RELOC_SOFTC | offsetof(struct sym_hcb, label))
  170. #define HADDR_2(label,ofs) (RELOC_SOFTC | \
  171. (offsetof(struct sym_hcb, label)+(ofs)))
  172. #define RADDR_1(label) (RELOC_REGISTER | REG(label))
  173. #define RADDR_2(label,ofs) (RELOC_REGISTER | ((REG(label))+(ofs)))
  174. #define SYM_GEN_PADDR_A(s, label) (RELOC_LABEL_A | offsetof(s, label))
  175. #define SYM_GEN_PADDR_B(s, label) (RELOC_LABEL_B | offsetof(s, label))
  176. #define SCR_DATA_ZERO 0xf00ff00f
  177. #endif /* SYM_FW_H */