i2hw.h
上传用户:jlfgdled
上传日期:2013-04-10
资源大小:33168k
文件大小:29k
源码类别:

Linux/Unix编程

开发平台:

Unix_Linux

  1. /*******************************************************************************
  2. *
  3. *   (c) 1999 by Computone Corporation
  4. *
  5. ********************************************************************************
  6. *
  7. *
  8. *   PACKAGE:     Linux tty Device Driver for IntelliPort II family of multiport
  9. *                serial I/O controllers.
  10. *
  11. *   DESCRIPTION: Definitions limited to properties of the hardware or the
  12. *                bootstrap firmware. As such, they are applicable regardless of
  13. *                operating system or loadware (standard or diagnostic).
  14. *
  15. *******************************************************************************/
  16. #ifndef I2HW_H
  17. #define I2HW_H 1
  18. //------------------------------------------------------------------------------
  19. // Revision History:
  20. //
  21. // 23 September 1991 MAG   First Draft Started...through...
  22. // 11 October 1991   ...   Continuing development...
  23. //  6 August 1993          Added support for ISA-4 (asic) which is architected
  24. //                         as an ISA-CEX with a single 4-port box.
  25. //
  26. // 20 December 1996  AKM   Version for Linux
  27. //
  28. //------------------------------------------------------------------------------
  29. /*------------------------------------------------------------------------------
  30. HARDWARE DESCRIPTION:
  31. Introduction:
  32. The IntelliPort-II and IntelliPort-IIEX products occupy a block of eight (8)
  33. addresses in the host's I/O space.
  34. Some addresses are used to transfer data to/from the board, some to transfer
  35. so-called "mailbox" messages, and some to read bit-mapped status information.
  36. While all the products in the line are functionally similar, some use a 16-bit
  37. data path to transfer data while others use an 8-bit path. Also, the use of
  38. command /status/mailbox registers differs slightly between the II and IIEX
  39. branches of the family.
  40. The host determines what type of board it is dealing with by reading a string of
  41. sixteen characters from the board. These characters are always placed in the
  42. fifo by the board's local processor whenever the board is reset (either from
  43. power-on or under software control) and are known as the "Power-on Reset
  44. Message." In order that this message can be read from either type of board, the
  45. hardware registers used in reading this message are the same. Once this message
  46. has been read by the host, then it has the information required to operate.
  47. General Differences between boards:
  48. The greatest structural difference is between the -II and -IIEX families of
  49. product. The -II boards use the Am4701 dual 512x8 bidirectional fifo to support
  50. the data path, mailbox registers, and status registers. This chip contains some
  51. features which are not used in the IntelliPort-II products; a description of
  52. these is omitted here. Because of these many features, it contains many
  53. registers, too many to access directly within a small address space. They are
  54. accessed by first writing a value to a "pointer" register. This value selects
  55. the register to be accessed.  The next read or write to that address accesses
  56. the selected register rather than the pointer register.
  57. The -IIEX boards use a proprietary design similar to the Am4701 in function. But
  58. because of a simpler, more streamlined design it doesn't require so many
  59. registers. This means they can be accessed directly in single operations rather
  60. than through a pointer register.
  61. Besides these differences, there are differences in whether 8-bit or 16-bit
  62. transfers are used to move data to the board.
  63. The -II boards are capable only of 8-bit data transfers, while the -IIEX boards
  64. may be configured for either 8-bit or 16-bit data transfers. If the on-board DIP
  65. switch #8 is ON, and the card has been installed in a 16-bit slot, 16-bit
  66. transfers are supported (and will be expected by the standard loadware). The
  67. on-board firmware can determine the position of the switch, and whether the
  68. board is installed in a 16-bit slot; it supplies this information to the host as
  69. part of the power-up reset message.
  70. The configuration switch (#8) and slot selection do not directly configure the
  71. hardware. It is up to the on-board loadware and host-based drivers to act
  72. according to the selected options. That is, loadware and drivers could be
  73. written to perform 8-bit transfers regardless of the state of the DIP switch or
  74. slot (and in a diagnostic environment might well do so). Likewise, 16-bit
  75. transfers could be performed as long as the card is in a 16-bit slot.
  76. Note the slot selection and DIP switch selection are provided separately: a
  77. board running in 8-bit mode in a 16-bit slot has a greater range of possible
  78. interrupts to choose from; information of potential use to the host.
  79. All 8-bit data transfers are done in the same way, regardless of whether on a
  80. -II board or a -IIEX board.
  81. The host must consider two things then: 1) whether a -II or -IIEX product is
  82. being used, and 2) whether an 8-bit or 16-bit data path is used.
  83. A further difference is that -II boards always have a 512-byte fifo operating in
  84. each direction. -IIEX boards may use fifos of varying size; this size is
  85. reported as part of the power-up message.
  86. I/O Map Of IntelliPort-II and IntelliPort-IIEX boards:
  87. (Relative to the chosen base address)
  88. Addr  R/W      IntelliPort-II    IntelliPort-IIEX
  89. ----  ---      --------------    ----------------
  90. 0     R/W      Data Port (byte)  Data Port (byte or word)
  91. 1     R/W      (Not used)        (MSB of word-wide data written to Data Port)
  92. 2     R        Status Register   Status Register
  93. 2     W        Pointer Register  Interrupt Mask Register
  94. 3     R/W      (Not used)        Mailbox Registers (6 bits: 11111100)
  95. 4,5   --       Reserved for future products
  96. 6     --       Reserved for future products
  97. 7     R        Guaranteed to have no effect
  98. 7     W        Hardware reset of board.
  99. Rules:
  100. All data transfers are performed using the even i/o address. If byte-wide data
  101. transfers are being used, do INB/OUTB operations on the data port. If word-wide
  102. transfers are used, do INW/OUTW operations. In some circumstances (such as
  103. reading the power-up message) you will do INB from the data port, but in this
  104. case the MSB of each word read is lost. When accessing all other unreserved
  105. registers, use byte operations only.
  106. ------------------------------------------------------------------------------*/
  107. //------------------------------------------------
  108. // Mandatory Includes:
  109. //------------------------------------------------
  110. //
  111. #include "ip2types.h"
  112. #include "i2os.h"    /* For any o.s., compiler, or host-related issues */
  113. //-------------------------------------------------------------------------
  114. // Manifests for the I/O map:
  115. //-------------------------------------------------------------------------
  116. // R/W: Data port (byte) for IntelliPort-II,
  117. // R/W: Data port (byte or word) for IntelliPort-IIEX
  118. // Incoming or outgoing data passes through a FIFO, the status of which is
  119. // available in some of the bits in FIFO_STATUS. This (bidirectional) FIFO is
  120. // the primary means of transferring data, commands, flow-control, and status
  121. // information between the host and board.
  122. //
  123. #define FIFO_DATA 0
  124. // Another way of passing information between the board and the host is
  125. // through "mailboxes". Unlike a FIFO, a mailbox holds only a single byte of
  126. // data.  Writing data to the mailbox causes a status bit to be set, and
  127. // potentially interrupting the intended receiver. The sender has some way to
  128. // determine whether the data has been read yet; as soon as it has, it may send
  129. // more. The mailboxes are handled differently on -II and -IIEX products, as
  130. // suggested below.
  131. //------------------------------------------------------------------------------
  132. // Read: Status Register for IntelliPort-II or -IIEX
  133. // The presence of any bit set here will cause an interrupt to the host,
  134. // provided the corresponding bit has been unmasked in the interrupt mask
  135. // register. Furthermore, interrupts to the host are disabled globally until the
  136. // loadware selects the irq line to use. With the exception of STN_MR, the bits
  137. // remain set so long as the associated condition is true.
  138. //
  139. #define FIFO_STATUS 2
  140. // Bit map of status bits which are identical for -II and -IIEX
  141. //
  142. #define ST_OUT_FULL  0x40  // Outbound FIFO full
  143. #define ST_IN_EMPTY  0x20  // Inbound FIFO empty
  144. #define ST_IN_MAIL   0x04  // Inbound Mailbox full
  145. // The following exists only on the Intelliport-IIEX, and indicates that the
  146. // board has not read the last outgoing mailbox data yet. In the IntelliPort-II,
  147. // the outgoing mailbox may be read back: a zero indicates the board has read
  148. // the data.
  149. //
  150. #define STE_OUT_MAIL 0x80  // Outbound mailbox full (!)
  151. // The following bits are defined differently for -II and -IIEX boards. Code
  152. // which relies on these bits will need to be functionally different for the two
  153. // types of boards and should be generally avoided because of the additional
  154. // complexity this creates:
  155. // Bit map of status bits only on -II
  156. // Fifo has been RESET (cleared when the status register is read). Note that
  157. // this condition cannot be masked and would always interrupt the host, except
  158. // that the hardware reset also disables interrupts globally from the board
  159. // until re-enabled by loadware. This could also arise from the
  160. // Am4701-supported command to reset the chip, but this command is generally not
  161. // used here.
  162. //
  163. #define STN_MR       0x80
  164. // See the AMD Am4701 data sheet for details on the following four bits. They
  165. // are not presently used by Computone drivers.
  166. //
  167. #define STN_OUT_AF  0x10  // Outbound FIFO almost full (programmable)
  168. #define STN_IN_AE   0x08  // Inbound FIFO almost empty (programmable)
  169. #define STN_BD      0x02  // Inbound byte detected
  170. #define STN_PE      0x01  // Parity/Framing condition detected
  171. // Bit-map of status bits only on -IIEX
  172. //
  173. #define STE_OUT_HF  0x10  // Outbound FIFO half full
  174. #define STE_IN_HF   0x08  // Inbound FIFO half full
  175. #define STE_IN_FULL 0x02  // Inbound FIFO full
  176. #define STE_OUT_MT  0x01  // Outbound FIFO empty
  177. //------------------------------------------------------------------------------
  178. // Intelliport-II -- Write Only: the pointer register.
  179. // Values are written to this register to select the Am4701 internal register to
  180. // be accessed on the next operation.
  181. //
  182. #define FIFO_PTR    0x02
  183. // Values for the pointer register
  184. //
  185. #define SEL_COMMAND 0x1    // Selects the Am4701 command register
  186. // Some possible commands:
  187. //
  188. #define SEL_CMD_MR  0x80 // Am4701 command to reset the chip
  189. #define SEL_CMD_SH  0x40 // Am4701 command to map the "other" port into the
  190. // status register.
  191. #define SEL_CMD_UNSH   0 // Am4701 command to "unshift": port maps into its
  192. // own status register.
  193. #define SEL_MASK     0x2 // Selects the Am4701 interrupt mask register. The
  194. // interrupt mask register is bit-mapped to match 
  195. // the status register (FIFO_STATUS) except for
  196. // STN_MR. (See above.)
  197. #define SEL_BYTE_DET 0x3 // Selects the Am4701 byte-detect register. (Not
  198. // normally used except in diagnostics.)
  199. #define SEL_OUTMAIL  0x4 // Selects the outbound mailbox (R/W). Reading back
  200. // a value of zero indicates that the mailbox has
  201. // been read by the board and is available for more
  202. // data./ Writing to the mailbox optionally
  203. // interrupts the board, depending on the loadware's
  204. // setting of its interrupt mask register.
  205. #define SEL_AEAF     0x5 // Selects AE/AF threshold register.
  206. #define SEL_INMAIL   0x6 // Selects the inbound mailbox (Read)
  207. //------------------------------------------------------------------------------
  208. // IntelliPort-IIEX --  Write Only: interrupt mask (and misc flags) register:
  209. // Unlike IntelliPort-II, bit assignments do NOT match those of the status
  210. // register.
  211. //
  212. #define FIFO_MASK    0x2
  213. // Mailbox readback select:
  214. // If set, reads to FIFO_MAIL will read the OUTBOUND mailbox (host to board). If
  215. // clear (default on reset) reads to FIFO_MAIL will read the INBOUND mailbox.
  216. // This is the normal situation. The clearing of a mailbox is determined on
  217. // -IIEX boards by waiting for the STE_OUT_MAIL bit to clear. Readback
  218. // capability is provided for diagnostic purposes only.
  219. //
  220. #define  MX_OUTMAIL_RSEL   0x80
  221. #define  MX_IN_MAIL  0x40 // Enables interrupts when incoming mailbox goes
  222. // full (ST_IN_MAIL set).
  223. #define  MX_IN_FULL  0x20 // Enables interrupts when incoming FIFO goes full
  224. // (STE_IN_FULL).
  225. #define  MX_IN_MT    0x08 // Enables interrupts when incoming FIFO goes empty
  226. // (ST_IN_MT).
  227. #define  MX_OUT_FULL 0x04 // Enables interrupts when outgoing FIFO goes full
  228. // (ST_OUT_FULL).
  229. #define  MX_OUT_MT   0x01 // Enables interrupts when outgoing FIFO goes empty
  230. // (STE_OUT_MT).
  231. // Any remaining bits are reserved, and should be written to ZERO for
  232. // compatibility with future Computone products.
  233. //------------------------------------------------------------------------------
  234. // IntelliPort-IIEX: -- These are only 6-bit mailboxes !!! -- 11111100 (low two
  235. // bits always read back 0).
  236. // Read:  One of the mailboxes, usually Inbound.
  237. //        Inbound Mailbox (MX_OUTMAIL_RSEL = 0)
  238. //        Outbound Mailbox (MX_OUTMAIL_RSEL = 1)
  239. // Write: Outbound Mailbox
  240. // For the IntelliPort-II boards, the outbound mailbox is read back to determine
  241. // whether the board has read the data (0 --> data has been read). For the
  242. // IntelliPort-IIEX, this is done by reading a status register. To determine
  243. // whether mailbox is available for more outbound data, use the STE_OUT_MAIL bit
  244. // in FIFO_STATUS. Moreover, although the Outbound Mailbox can be read back by
  245. // setting MX_OUTMAIL_RSEL, it is NOT cleared when the board reads it, as is the
  246. // case with the -II boards. For this reason, FIFO_MAIL is normally used to read
  247. // the inbound FIFO, and MX_OUTMAIL_RSEL kept clear. (See above for
  248. // MX_OUTMAIL_RSEL description.)
  249. //
  250. #define  FIFO_MAIL   0x3
  251. //------------------------------------------------------------------------------
  252. // WRITE ONLY:  Resets the board. (Data doesn't matter).
  253. //
  254. #define  FIFO_RESET  0x7
  255. //------------------------------------------------------------------------------
  256. // READ ONLY:  Will have no effect. (Data is undefined.)
  257. // Actually, there will be an effect, in that the operation is sure to generate
  258. // a bus cycle: viz., an I/O byte Read. This fact can be used to enforce short
  259. // delays when no comparable time constant is available.
  260. //
  261. #define  FIFO_NOP    0x7
  262. //------------------------------------------------------------------------------
  263. // RESET & POWER-ON RESET MESSAGE
  264. /*------------------------------------------------------------------------------
  265. RESET:
  266. The IntelliPort-II and -IIEX boards are reset in three ways: Power-up, channel
  267. reset, and via a write to the reset register described above. For products using
  268. the ISA bus, these three sources of reset are equvalent. For MCA and EISA buses,
  269. the Power-up and channel reset sources cause additional hardware initialization
  270. which should only occur at system startup time.
  271. The third type of reset, called a "command reset", is done by writing any data
  272. to the FIFO_RESET address described above. This resets the on-board processor,
  273. FIFO, UARTS, and associated hardware.
  274. This passes control of the board to the bootstrap firmware, which performs a
  275. Power-On Self Test and which detects its current configuration. For example,
  276. -IIEX products determine the size of FIFO which has been installed, and the
  277. number and type of expansion boxes attached.
  278. This and other information is then written to the FIFO in a 16-byte data block
  279. to be read by the host. This block is guaranteed to be present within two (2)
  280. seconds of having received the command reset. The firmware is now ready to
  281. receive loadware from the host.
  282. It is good practice to perform a command reset to the board explicitly as part
  283. of your software initialization.  This allows your code to properly restart from
  284. a soft boot. (Many systems do not issue channel reset on soft boot).
  285. Because of a hardware reset problem on some of the Cirrus Logic 1400's which are
  286. used on the product, it is recommended that you reset the board twice, separated
  287. by an approximately 50 milliseconds delay. (VERY approximately: probably ok to
  288. be off by a factor of five. The important point is that the first command reset
  289. in fact generates a reset pulse on the board. This pulse is guaranteed to last
  290. less than 10 milliseconds. The additional delay ensures the 1400 has had the
  291. chance to respond sufficiently to the first reset. Why not a longer delay? Much
  292. more than 50 milliseconds gets to be noticable, but the board would still work.
  293. Once all 16 bytes of the Power-on Reset Message have been read, the bootstrap
  294. firmware is ready to receive loadware.
  295. Note on Power-on Reset Message format:
  296. The various fields have been designed with future expansion in view.
  297. Combinations of bitfields and values have been defined which define products
  298. which may not currently exist. This has been done to allow drivers to anticipate
  299. the possible introduction of products in a systematic fashion. This is not
  300. intended to suggest that each potential product is actually under consideration.
  301. ------------------------------------------------------------------------------*/
  302. //----------------------------------------
  303. // Format of Power-on Reset Message
  304. //----------------------------------------
  305. typedef union _porStr // "por" stands for Power On Reset
  306. {
  307. unsigned char  c[16]; // array used when considering the message as a
  308. // string of undifferentiated characters
  309. struct // Elements used when considering values
  310. {
  311. // The first two bytes out of the FIFO are two magic numbers. These are
  312. // intended to establish that there is indeed a member of the
  313. // IntelliPort-II(EX) family present. The remaining bytes may be 
  314. // expected // to be valid. When reading the Power-on Reset message, 
  315. // if the magic numbers do not match it is probably best to stop
  316. // reading immediately. You are certainly not reading our board (unless
  317. // hardware is faulty), and may in fact be reading some other piece of
  318. // hardware.
  319. unsigned char porMagic1;   // magic number: first byte == POR_MAGIC_1 
  320. unsigned char porMagic2;   // magic number: second byte == POR_MAGIC_2 
  321. // The Version, Revision, and Subrevision are stored as absolute numbers
  322. // and would normally be displayed in the format V.R.S (e.g. 1.0.2)
  323. unsigned char porVersion;  // Bootstrap firmware version number
  324. unsigned char porRevision; // Bootstrap firmware revision number
  325. unsigned char porSubRev;   // Bootstrap firmware sub-revision number
  326. unsigned char porID; // Product ID:  Bit-mapped according to
  327. // conventions described below. Among other
  328. // things, this allows us to distinguish
  329. // IntelliPort-II boards from IntelliPort-IIEX
  330. // boards.
  331. unsigned char porBus; // IntelliPort-II: Unused
  332. // IntelliPort-IIEX: Bus Information:
  333. // Bit-mapped below
  334. unsigned char porMemory; // On-board DRAM size: in 32k blocks
  335. // porPorts1 (and porPorts2) are used to determine the ports which are
  336. // available to the board. For non-expandable product, a single number 
  337. // is sufficient. For expandable product, the board may be connected
  338. // to as many as four boxes. Each box may be (so far) either a 16-port
  339. // or an 8-port size. Whenever an 8-port box is used, the remaining 8
  340. // ports leave gaps between existing channels. For that reason,
  341. // expandable products must report a MAP of available channels. Since 
  342. // each UART supports four ports, we represent each UART found by a
  343. // single bit. Using two bytes to supply the mapping information we
  344. // report the presense or absense of up to 16 UARTS, or 64 ports in
  345. // steps of 4 ports. For -IIEX products, the ports are numbered
  346. // starting at the box closest to the controller in the "chain".
  347. // Interpreted Differently for IntelliPort-II and -IIEX.
  348. // -II:   Number of ports (Derived actually from product ID). See
  349. // Diag1&2 to indicate if uart was actually detected.
  350. // -IIEX: Bit-map of UARTS found, LSB (see below for MSB of this). This
  351. //        bitmap is based on detecting the uarts themselves; 
  352. //        see porFlags for information from the box i.d's.
  353. unsigned char  porPorts1;
  354. unsigned char  porDiag1; // Results of on-board P.O.S.T, 1st byte
  355. unsigned char  porDiag2; // Results of on-board P.O.S.T, 2nd byte
  356. unsigned char  porSpeed; // Speed of local CPU: given as MHz x10
  357. // e.g., 16.0 MHz CPU is reported as 160
  358. unsigned char  porFlags; // Misc information (see manifests below)
  359. // Bit-mapped: CPU type, UART's present
  360. unsigned char  porPorts2; // -II:  Undefined
  361. // -IIEX: Bit-map of UARTS found, MSB (see
  362. //        above for LSB)
  363. // IntelliPort-II: undefined
  364. // IntelliPort-IIEX: 1 << porFifoSize gives the size, in bytes, of the
  365. // host interface FIFO, in each direction. When running the -IIEX in
  366. // 8-bit mode, fifo capacity is halved. The bootstrap firmware will
  367. // have already accounted for this fact in generating this number.
  368. unsigned char  porFifoSize;
  369. // IntelliPort-II: undefined
  370. // IntelliPort-IIEX: The number of boxes connected. (Presently 1-4)
  371. unsigned char  porNumBoxes;
  372. } e;
  373. } porStr, *porStrPtr;
  374. //--------------------------
  375. // Values for porStr fields
  376. //--------------------------
  377. //---------------------
  378. // porMagic1, porMagic2
  379. //----------------------
  380. //
  381. #define  POR_MAGIC_1    0x96  // The only valid value for porMagic1
  382. #define  POR_MAGIC_2    0x35  // The only valid value for porMagic2
  383. #define  POR_1_INDEX    0     // Byte position of POR_MAGIC_1
  384. #define  POR_2_INDEX    1     // Ditto for POR_MAGIC_2
  385. //----------------------
  386. // porID
  387. //----------------------
  388. //
  389. #define  POR_ID_FAMILY  0xc0 // These bits indicate the general family of
  390. // product.
  391. #define  POR_ID_FII     0x00 // Family is "IntelliPort-II"
  392. #define  POR_ID_FIIEX   0x40 // Family is "IntelliPort-IIEX"
  393. // These bits are reserved, presently zero. May be used at a later date to
  394. // convey other product information.
  395. //
  396. #define POR_ID_RESERVED 0x3c
  397. #define POR_ID_SIZE     0x03 // Remaining bits indicate number of ports &
  398. // Connector information.
  399. #define POR_ID_II_8     0x00 // For IntelliPort-II, indicates 8-port using
  400. // standard brick.
  401. #define POR_ID_II_8R    0x01 // For IntelliPort-II, indicates 8-port using
  402. // RJ11's (no CTS)
  403. #define POR_ID_II_6     0x02 // For IntelliPort-II, indicates 6-port using
  404. // RJ45's
  405. #define POR_ID_II_4     0x03 // For IntelliPort-II, indicates 4-port using
  406. // 4xRJ45 connectors
  407. #define POR_ID_EX       0x00 // For IntelliPort-IIEX, indicates standard
  408. // expandable controller (other values reserved)
  409. //----------------------
  410. // porBus
  411. //----------------------
  412. // IntelliPort-IIEX only: Board is installed in a 16-bit slot
  413. //
  414. #define POR_BUS_SLOT16  0x20
  415. // IntelliPort-IIEX only: DIP switch #8 is on, selecting 16-bit host interface
  416. // operation.
  417. // 
  418. #define POR_BUS_DIP16   0x10
  419. // Bits 0-2 indicate type of bus: This information is stored in the bootstrap
  420. // loadware, different loadware being used on different products for different
  421. // buses. For most situations, the drivers do not need this information; but it
  422. // is handy in a diagnostic environment. For example, on microchannel boards,
  423. // you would not want to try to test several interrupts, only the one for which
  424. // you were configured.
  425. //
  426. #define  POR_BUS_TYPE   0x07
  427. // Unknown:  this product doesn't know what bus it is running in. (e.g. if same
  428. // bootstrap firmware were wanted for two different buses.)
  429. //
  430. #define  POR_BUS_T_UNK  0
  431. // Note: existing firmware for ISA-8 and MC-8 currently report the POR_BUS_T_UNK
  432. // state, since the same bootstrap firmware is used for each.
  433. #define  POR_BUS_T_MCA  1  // MCA BUS */
  434. #define  POR_BUS_T_EISA 2  // EISA BUS */
  435. #define  POR_BUS_T_ISA  3  // ISA BUS */
  436. // Values 4-7 Reserved
  437. // Remaining bits are reserved
  438. //----------------------
  439. // porDiag1
  440. //----------------------
  441. #define  POR_BAD_MAPPER 0x80 // HW failure on P.O.S.T: Chip mapper failed
  442. // These two bits valid only for the IntelliPort-II
  443. //
  444. #define  POR_BAD_UART1  0x01 // First  1400 bad
  445. #define  POR_BAD_UART2  0x02 // Second 1400 bad
  446. //----------------------
  447. // porDiag2
  448. //----------------------
  449. #define  POR_DEBUG_PORT 0x80 // debug port was detected by the P.O.S.T
  450. #define  POR_DIAG_OK    0x00 // Indicates passage: Failure codes not yet
  451. // available.
  452. // Other bits undefined.
  453. //----------------------
  454. // porFlags
  455. //----------------------
  456. #define  POR_CPU     0x03 // These bits indicate supposed CPU type
  457. #define  POR_CPU_8   0x01 // Board uses an 80188 (no such thing yet)
  458. #define  POR_CPU_6   0x02 // Board uses an 80186 (all existing products)
  459. #define  POR_CEX4    0x04 // If set, this is an ISA-CEX/4: An ISA-4 (asic)
  460. // which is architected like an ISA-CEX connected
  461. // to a (hitherto impossible) 4-port box.
  462. #define POR_BOXES    0xf0 // Valid for IntelliPort-IIEX only: Map of Box
  463. // sizes based on box I.D.
  464. #define POR_BOX_16   0x10 // Set indicates 16-port, clear 8-port
  465. //-------------------------------------
  466. // LOADWARE and DOWNLOADING CODE
  467. //-------------------------------------
  468. /*
  469. Loadware may be sent to the board in two ways:
  470. 1) It may be read from a (binary image) data file block by block as each block
  471. is sent to the board. This is only possible when the initialization is
  472. performed by code which can access your file system. This is most suitable
  473. for diagnostics and appications which use the interface library directly.
  474. 2) It may be hard-coded into your source by including a .h file (typically
  475. supplied by Computone), which declares a data array and initializes every
  476. element. This acheives the same result as if an entire loadware file had 
  477. been read into the array.
  478. This requires more data space in your program, but access to the file system
  479. is not required. This method is more suited to driver code, which typically
  480. is running at a level too low to access the file system directly.
  481. At present, loadware can only be generated at Computone.
  482. All Loadware begins with a header area which has a particular format. This
  483. includes a magic number which identifies the file as being (purportedly)
  484. loadware, CRC (for the loader), and version information.
  485. */
  486. //-----------------------------------------------------------------------------
  487. // Format of loadware block
  488. //
  489. // This is defined as a union so we can pass a pointer to one of these items
  490. // and (if it is the first block) pick out the version information, etc.
  491. //
  492. // Otherwise, to deal with this as a simple character array
  493. //------------------------------------------------------------------------------
  494. #define LOADWARE_BLOCK_SIZE   512   // Number of bytes in each block of loadware
  495. typedef union _loadHdrStr
  496. {
  497. unsigned char c[LOADWARE_BLOCK_SIZE];  // Valid for every block
  498. struct // These fields are valid for only the first block of loadware.
  499. {
  500. unsigned char loadMagic; // Magic number: see below
  501. unsigned char loadBlocksMore; // How many more blocks?
  502. unsigned char loadCRC[2]; // Two CRC bytes: used by loader
  503. unsigned char loadVersion; // Version number
  504. unsigned char loadRevision; // Revision number
  505. unsigned char loadSubRevision; // Sub-revision number
  506. unsigned char loadSpares[9]; // Presently unused
  507. unsigned char loadDates[32]; // Null-terminated string which can give
  508. // date and time of compilation
  509. } e;
  510. } loadHdrStr, *loadHdrStrPtr;
  511. //------------------------------------
  512. // Defines for downloading code:
  513. //------------------------------------
  514. // The loadMagic field in the first block of the loadfile must be this, else the
  515. // file is not valid.
  516. //
  517. #define  MAGIC_LOADFILE 0x3c
  518. // How do we know the load was successful? On completion of the load, the
  519. // bootstrap firmware returns a code to indicate whether it thought the download
  520. // was valid and intends to execute it. These are the only possible valid codes:
  521. //
  522. #define  LOADWARE_OK    0xc3        // Download was ok
  523. #define  LOADWARE_BAD   0x5a        // Download was bad (CRC error)
  524. // Constants applicable to writing blocks of loadware:
  525. // The first block of loadware might take 600 mS to load, in extreme cases.
  526. // (Expandable board: worst case for sending startup messages to the LCD's).
  527. // The 600mS figure is not really a calculation, but a conservative
  528. // guess/guarantee. Usually this will be within 100 mS, like subsequent blocks.
  529. //
  530. #define  MAX_DLOAD_START_TIME 1000  // 1000 mS
  531. #define  MAX_DLOAD_READ_TIME  100   // 100 mS
  532. // Firmware should respond with status (see above) within this long of host
  533. // having sent the final block.
  534. //
  535. #define  MAX_DLOAD_ACK_TIME   100   // 100 mS, again!
  536. //------------------------------------------------------
  537. // MAXIMUM NUMBER OF PORTS PER BOARD:
  538. // This is fixed for now (with the expandable), but may
  539. // be expanding according to even newer products.
  540. //------------------------------------------------------
  541. //
  542. #define ABS_MAX_BOXES   4     // Absolute most boxes per board
  543. #define ABS_BIGGEST_BOX 16    // Absolute the most ports per box
  544. #define ABS_MOST_PORTS  (ABS_MAX_BOXES * ABS_BIGGEST_BOX)
  545. #endif   // I2HW_H