include/asm-arm/ecard.h

   1 /*
   2  * linux/include/asm-arm/ecard.h
   3  *
   4  * definitions for expansion cards
   5  *
   6  * This is a new system as from Linux 1.2.3
   7  *
   8  * Changelog:
   9  *  11-12-1996  RMK     Further minor improvements
  10  *  12-09-1997  RMK     Added interrupt enable/disable for card level
  11  *
  12  * Reference: Acorns Risc OS 3 Programmers Reference Manuals.
  13  */
  14
  15 #ifndef __ASM_ECARD_H
  16 #define __ASM_ECARD_H
  17
  18 /*
  19  * Currently understood cards (but not necessarily
  20  * supported):
  21  *                        Manufacturer  Product ID
  22  */
  23 #define MANU_ACORN              0x0000
  24 #define PROD_ACORN_SCSI                 0x0002
  25 #define PROD_ACORN_ETHER1               0x0003
  26 #define PROD_ACORN_MFM                  0x000b
  27
  28 #define MANU_ANT2               0x0011
  29 #define PROD_ANT_ETHER3                 0x00a4
  30
  31 #define MANU_ATOMWIDE           0x0017
  32 #define PROD_ATOMWIDE_3PSERIAL          0x0090
  33
  34 #define MANU_IRLAM_INSTRUMENTS  0x001f
  35 #define MANU_IRLAM_INSTRUMENTS_ETHERN   0x5678
  36
  37 #define MANU_OAK                0x0021
  38 #define PROD_OAK_SCSI                   0x0058
  39
  40 #define MANU_MORLEY             0x002b
  41 #define PROD_MORLEY_SCSI_UNCACHED       0x0067
  42
  43 #define MANU_CUMANA             0x003a
  44 #define PROD_CUMANA_SCSI_2              0x003a
  45 #define PROD_CUMANA_SCSI_1              0x00a0
  46
  47 #define MANU_ICS                0x003c
  48 #define PROD_ICS_IDE                    0x00ae
  49
  50 #define MANU_ICS2               0x003d
  51 #define PROD_ICS2_IDE                   0x00ae
  52
  53 #define MANU_SERPORT            0x003f
  54 #define PROD_SERPORT_DSPORT             0x00b9
  55
  56 #define MANU_I3                 0x0046
  57 #define PROD_I3_ETHERLAN500             0x00d4
  58 #define PROD_I3_ETHERLAN600             0x00ec
  59 #define PROD_I3_ETHERLAN600A            0x011e
  60
  61 #define MANU_ANT                0x0053
  62 #define PROD_ANT_ETHERM                 0x00d8
  63 #define PROD_ANT_ETHERB                 0x00e4
  64
  65 #define MANU_ALSYSTEMS          0x005b
  66 #define PROD_ALSYS_SCSIATAPI            0x0107
  67
  68 #define MANU_MCS                0x0063
  69 #define PROD_MCS_CONNECT32              0x0125
  70
  71 #define MANU_EESOX              0x0064
  72 #define PROD_EESOX_SCSI2                0x008c
  73
  74 #define MANU_YELLOWSTONE        0x0096
  75 #define PROD_YELLOWSTONE_RAPIDE32       0x0120
  76
  77 #ifdef ECARD_C
  78 #define CONST
  79 #else
  80 #define CONST const
  81 #endif
  82
  83 #define MAX_ECARDS      9
  84
  85 typedef enum {                          /* Cards address space          */
  86         ECARD_IOC,
  87         ECARD_MEMC,
  88         ECARD_EASI
  89 } card_type_t;
  90
  91 typedef enum {                          /* Speed for ECARD_IOC space    */
  92         ECARD_SLOW       = 0,
  93         ECARD_MEDIUM     = 1,
  94         ECARD_FAST       = 2,
  95         ECARD_SYNC       = 3
  96 } card_speed_t;
  97
  98 typedef struct  {                       /* Card ID structure            */
  99         unsigned short manufacturer;
 100         unsigned short product;
 101 } card_ids;
 102
 103 struct in_ecid {                        /* Packed card ID information   */
 104         unsigned short  product;        /* Product code                 */
 105         unsigned short  manufacturer;   /* Manufacturer code            */
 106         unsigned char   id:4;           /* Simple ID                    */
 107         unsigned char   cd:1;           /* Chunk dir present            */
 108         unsigned char   is:1;           /* Interrupt status pointers    */
 109         unsigned char   w:2;            /* Width                        */
 110         unsigned char   country;        /* Country                      */
 111         unsigned char   irqmask;        /* IRQ mask                     */
 112         unsigned char   fiqmask;        /* FIQ mask                     */
 113         unsigned long   irqoff;         /* IRQ offset                   */
 114         unsigned long   fiqoff;         /* FIQ offset                   */
 115 };
 116
 117 typedef struct expansion_card ecard_t;
 118 typedef unsigned long *loader_t;
 119
 120 typedef struct {                        /* Card handler routines        */
 121         void (*irqenable)(ecard_t *ec, int irqnr);
 122         void (*irqdisable)(ecard_t *ec, int irqnr);
 123         int  (*irqpending)(ecard_t *ec);
 124         void (*fiqenable)(ecard_t *ec, int fiqnr);
 125         void (*fiqdisable)(ecard_t *ec, int fiqnr);
 126         int  (*fiqpending)(ecard_t *ec);
 127 } expansioncard_ops_t;
 128
 129 /*
 130  * This contains all the info needed on an expansion card
 131  */
 132 struct expansion_card {
 133         struct expansion_card  *next;
 134
 135         /* Public data */
 136         volatile unsigned char *irqaddr;        /* address of IRQ register      */
 137         volatile unsigned char *fiqaddr;        /* address of FIQ register      */
 138         unsigned char           irqmask;        /* IRQ mask                     */
 139         unsigned char           fiqmask;        /* FIQ mask                     */
 140         unsigned char           claimed;        /* Card claimed?                */
 141
 142         void                    *irq_data;      /* Data for use for IRQ by card */
 143         void                    *fiq_data;      /* Data for use for FIQ by card */
 144         expansioncard_ops_t     *ops;           /* Enable/Disable Ops for card  */
 145
 146         CONST unsigned int      slot_no;        /* Slot number                  */
 147         CONST unsigned int      dma;            /* DMA number (for request_dma) */
 148         CONST unsigned int      irq;            /* IRQ number (for request_irq) */
 149         CONST unsigned int      fiq;            /* FIQ number (for request_irq) */
 150         CONST card_type_t       type;           /* Type of card                 */
 151         CONST struct in_ecid    cid;            /* Card Identification          */
 152
 153         /* Private internal data */
 154         const char              *card_desc;     /* Card description             */
 155         CONST unsigned int      podaddr;        /* Base Linux address for card  */
 156         CONST loader_t          loader;         /* loader program */
 157 };
 158
 159 struct in_chunk_dir {
 160         unsigned int start_offset;
 161         union {
 162                 unsigned char string[256];
 163                 unsigned char data[1];
 164         } d;
 165 };
 166
 167 /*
 168  * ecard_claim: claim an expansion card entry
 169  */
 170 #define ecard_claim(ec) ((ec)->claimed = 1)
 171
 172 /*
 173  * ecard_release: release an expansion card entry
 174  */
 175 #define ecard_release(ec) ((ec)->claimed = 0)
 176
 177 /*
 178  * Start finding cards from the top of the list
 179  */
 180 extern void ecard_startfind (void);
 181
 182 /*
 183  * Find an expansion card with the correct cid, product and manufacturer code
 184  */
 185 extern struct expansion_card *ecard_find (int cid, const card_ids *ids);
 186
 187 /*
 188  * Read a chunk from an expansion card
 189  * cd : where to put read data
 190  * ec : expansion card info struct
 191  * id : id number to find
 192  * num: (n+1)'th id to find.
 193  */
 194 extern int ecard_readchunk (struct in_chunk_dir *cd, struct expansion_card *ec, int id, int num);
 195
 196 /*
 197  * Obtain the address of a card
 198  */
 199 extern unsigned int ecard_address (struct expansion_card *ec, card_type_t card_type, card_speed_t speed);
 200
 201 #ifdef ECARD_C
 202 /* Definitions internal to ecard.c - for it's use only!!
 203  *
 204  * External expansion card header as read from the card
 205  */
 206 struct ex_ecid {
 207         unsigned char   r_irq:1;
 208         unsigned char   r_zero:1;
 209         unsigned char   r_fiq:1;
 210         unsigned char   r_id:4;
 211         unsigned char   r_a:1;
 212
 213         unsigned char   r_cd:1;
 214         unsigned char   r_is:1;
 215         unsigned char   r_w:2;
 216         unsigned char   r_r1:4;
 217
 218         unsigned char   r_r2:8;
 219
 220         unsigned char   r_prod[2];
 221
 222         unsigned char   r_manu[2];
 223
 224         unsigned char   r_country;
 225
 226         unsigned char   r_irqmask;
 227         unsigned char   r_irqoff[3];
 228
 229         unsigned char   r_fiqmask;
 230         unsigned char   r_fiqoff[3];
 231 };
 232
 233 /*
 234  * Chunk directory entry as read from the card
 235  */
 236 struct ex_chunk_dir {
 237         unsigned char r_id;
 238         unsigned char r_len[3];
 239         unsigned long r_start;
 240         union {
 241                 char string[256];
 242                 char data[1];
 243         } d;
 244 #define c_id(x)         ((x)->r_id)
 245 #define c_len(x)        ((x)->r_len[0]|((x)->r_len[1]<<8)|((x)->r_len[2]<<16))
 246 #define c_start(x)      ((x)->r_start)
 247 };
 248
 249 #endif
 250
 251 #endif