include/linux/ioc4.h

   1 /*
   2  * This file is subject to the terms and conditions of the GNU General Public
   3  * License.  See the file "COPYING" in the main directory of this archive
   4  * for more details.
   5  *
   6  * Copyright (c) 2005 Silicon Graphics, Inc.  All Rights Reserved.
   7  */
   8
   9 #ifndef _LINUX_IOC4_H
  10 #define _LINUX_IOC4_H
  11
  12 #include <linux/interrupt.h>
  13
  14 /***********************************
  15  * Structures needed by subdrivers *
  16  ***********************************/
  17
  18 /* This structure fully describes the IOC4 miscellaneous registers which
  19  * appear at bar[0]+0x00000 through bar[0]+0x0005c.  The corresponding
  20  * PCI resource is managed by the main IOC4 driver because it contains
  21  * registers of interest to many different IOC4 subdrivers.
  22  */
  23 struct ioc4_misc_regs {
  24         /* Miscellaneous IOC4 registers */
  25         union ioc4_pci_err_addr_l {
  26                 uint32_t raw;
  27                 struct {
  28                         uint32_t valid:1;       /* Address captured */
  29                         uint32_t master_id:4;   /* Unit causing error
  30                                                  * 0/1: Serial port 0 TX/RX
  31                                                  * 2/3: Serial port 1 TX/RX
  32                                                  * 4/5: Serial port 2 TX/RX
  33                                                  * 6/7: Serial port 3 TX/RX
  34                                                  * 8: ATA/ATAPI
  35                                                  * 9-15: Undefined
  36                                                  */
  37                         uint32_t mul_err:1;     /* Multiple errors occurred */
  38                         uint32_t addr:26;       /* Bits 31-6 of error addr */
  39                 } fields;
  40         } pci_err_addr_l;
  41         uint32_t pci_err_addr_h;        /* Bits 63-32 of error addr */
  42         union ioc4_sio_int {
  43                 uint32_t raw;
  44                 struct {
  45                         uint8_t tx_mt:1;        /* TX ring buffer empty */
  46                         uint8_t rx_full:1;      /* RX ring buffer full */
  47                         uint8_t rx_high:1;      /* RX high-water exceeded */
  48                         uint8_t rx_timer:1;     /* RX timer has triggered */
  49                         uint8_t delta_dcd:1;    /* DELTA_DCD seen */
  50                         uint8_t delta_cts:1;    /* DELTA_CTS seen */
  51                         uint8_t intr_pass:1;    /* Interrupt pass-through */
  52                         uint8_t tx_explicit:1;  /* TX, MCW, or delay complete */
  53                 } fields[4];
  54         } sio_ir;               /* Serial interrupt state */
  55         union ioc4_other_int {
  56                 uint32_t raw;
  57                 struct {
  58                         uint32_t ata_int:1;     /* ATA port passthru */
  59                         uint32_t ata_memerr:1;  /* ATA halted by mem error */
  60                         uint32_t memerr:4;      /* Serial halted by mem err */
  61                         uint32_t kbd_int:1;     /* kbd/mouse intr asserted */
  62                         uint32_t reserved:16;   /* zero */
  63                         uint32_t rt_int:1;      /* INT_OUT section latch */
  64                         uint32_t gen_int:8;     /* Intr. from generic pins */
  65                 } fields;
  66         } other_ir;             /* Other interrupt state */
  67         union ioc4_sio_int sio_ies;     /* Serial interrupt enable set */
  68         union ioc4_other_int other_ies; /* Other interrupt enable set */
  69         union ioc4_sio_int sio_iec;     /* Serial interrupt enable clear */
  70         union ioc4_other_int other_iec; /* Other interrupt enable clear */
  71         union ioc4_sio_cr {
  72                 uint32_t raw;
  73                 struct {
  74                         uint32_t cmd_pulse:4;   /* Bytebus strobe width */
  75                         uint32_t arb_diag:3;    /* PCI bus requester */
  76                         uint32_t sio_diag_idle:1;       /* Active ser req? */
  77                         uint32_t ata_diag_idle:1;       /* Active ATA req? */
  78                         uint32_t ata_diag_active:1;     /* ATA req is winner */
  79                         uint32_t reserved:22;   /* zero */
  80                 } fields;
  81         } sio_cr;
  82         uint32_t unused1;
  83         union ioc4_int_out {
  84                 uint32_t raw;
  85                 struct {
  86                         uint32_t count:16;      /* Period control */
  87                         uint32_t mode:3;        /* Output signal shape */
  88                         uint32_t reserved:11;   /* zero */
  89                         uint32_t diag:1;        /* Timebase control */
  90                         uint32_t int_out:1;     /* Current value */
  91                 } fields;
  92         } int_out;              /* External interrupt output control */
  93         uint32_t unused2;
  94         union ioc4_gpcr {
  95                 uint32_t raw;
  96                 struct {
  97                         uint32_t dir:8; /* Pin direction */
  98                         uint32_t edge:8;        /* Edge/level mode */
  99                         uint32_t reserved1:4;   /* zero */
 100                         uint32_t int_out_en:1;  /* INT_OUT enable */
 101                         uint32_t reserved2:11;  /* zero */
 102                 } fields;
 103         } gpcr_s;               /* Generic PIO control set */
 104         union ioc4_gpcr gpcr_c; /* Generic PIO control clear */
 105         union ioc4_gpdr {
 106                 uint32_t raw;
 107                 struct {
 108                         uint32_t gen_pin:8;     /* State of pins */
 109                         uint32_t reserved:24;
 110                 } fields;
 111         } gpdr;                 /* Generic PIO data */
 112         uint32_t unused3;
 113         union ioc4_gppr {
 114                 uint32_t raw;
 115                 struct {
 116                         uint32_t gen_pin:1;     /* Single pin state */
 117                         uint32_t reserved:31;
 118                 } fields;
 119         } gppr[8];              /* Generic PIO pins */
 120 };
 121
 122 /* One of these per IOC4
 123  *
 124  * The idd_serial_data field is present here, even though it's used
 125  * solely by the serial subdriver, because the main IOC4 module
 126  * properly owns pci_{get,set}_drvdata functionality.  This field
 127  * allows that subdriver to stash its own drvdata somewhere.
 128  */
 129 struct ioc4_driver_data {
 130         struct list_head idd_list;
 131         unsigned long idd_bar0;
 132         struct pci_dev *idd_pdev;
 133         const struct pci_device_id *idd_pci_id;
 134         struct __iomem ioc4_misc_regs *idd_misc_regs;
 135         void *idd_serial_data;
 136 };
 137
 138 /* One per submodule */
 139 struct ioc4_submodule {
 140         struct list_head is_list;
 141         char *is_name;
 142         struct module *is_owner;
 143         int (*is_probe) (struct ioc4_driver_data *);
 144         int (*is_remove) (struct ioc4_driver_data *);
 145 };
 146
 147 #define IOC4_NUM_CARDS          8       /* max cards per partition */
 148
 149 /**********************************
 150  * Functions needed by submodules *
 151  **********************************/
 152
 153 extern int ioc4_register_submodule(struct ioc4_submodule *);
 154 extern void ioc4_unregister_submodule(struct ioc4_submodule *);
 155
 156 #endif                          /* _LINUX_IOC4_H */