122329b511a97557b293583194037d1f4c71e1504Brent Casavant/* 222329b511a97557b293583194037d1f4c71e1504Brent Casavant * This file is subject to the terms and conditions of the GNU General Public 322329b511a97557b293583194037d1f4c71e1504Brent Casavant * License. See the file "COPYING" in the main directory of this archive 422329b511a97557b293583194037d1f4c71e1504Brent Casavant * for more details. 522329b511a97557b293583194037d1f4c71e1504Brent Casavant * 622329b511a97557b293583194037d1f4c71e1504Brent Casavant * Copyright (c) 2005 Silicon Graphics, Inc. All Rights Reserved. 722329b511a97557b293583194037d1f4c71e1504Brent Casavant */ 822329b511a97557b293583194037d1f4c71e1504Brent Casavant 922329b511a97557b293583194037d1f4c71e1504Brent Casavant#ifndef _LINUX_IOC4_H 1022329b511a97557b293583194037d1f4c71e1504Brent Casavant#define _LINUX_IOC4_H 1122329b511a97557b293583194037d1f4c71e1504Brent Casavant 1222329b511a97557b293583194037d1f4c71e1504Brent Casavant#include <linux/interrupt.h> 1322329b511a97557b293583194037d1f4c71e1504Brent Casavant 14d4c477ca5448f19afaaf6c0cfd655009ea9e614dBrent Casavant/*************** 15d4c477ca5448f19afaaf6c0cfd655009ea9e614dBrent Casavant * Definitions * 16d4c477ca5448f19afaaf6c0cfd655009ea9e614dBrent Casavant ***************/ 17d4c477ca5448f19afaaf6c0cfd655009ea9e614dBrent Casavant 18d4c477ca5448f19afaaf6c0cfd655009ea9e614dBrent Casavant/* Miscellaneous values inherent to hardware */ 19d4c477ca5448f19afaaf6c0cfd655009ea9e614dBrent Casavant 20d4c477ca5448f19afaaf6c0cfd655009ea9e614dBrent Casavant#define IOC4_EXTINT_COUNT_DIVISOR 520 /* PCI clocks per COUNT tick */ 21d4c477ca5448f19afaaf6c0cfd655009ea9e614dBrent Casavant 2222329b511a97557b293583194037d1f4c71e1504Brent Casavant/*********************************** 2322329b511a97557b293583194037d1f4c71e1504Brent Casavant * Structures needed by subdrivers * 2422329b511a97557b293583194037d1f4c71e1504Brent Casavant ***********************************/ 2522329b511a97557b293583194037d1f4c71e1504Brent Casavant 2622329b511a97557b293583194037d1f4c71e1504Brent Casavant/* This structure fully describes the IOC4 miscellaneous registers which 2722329b511a97557b293583194037d1f4c71e1504Brent Casavant * appear at bar[0]+0x00000 through bar[0]+0x0005c. The corresponding 2822329b511a97557b293583194037d1f4c71e1504Brent Casavant * PCI resource is managed by the main IOC4 driver because it contains 2922329b511a97557b293583194037d1f4c71e1504Brent Casavant * registers of interest to many different IOC4 subdrivers. 3022329b511a97557b293583194037d1f4c71e1504Brent Casavant */ 3122329b511a97557b293583194037d1f4c71e1504Brent Casavantstruct ioc4_misc_regs { 3222329b511a97557b293583194037d1f4c71e1504Brent Casavant /* Miscellaneous IOC4 registers */ 3322329b511a97557b293583194037d1f4c71e1504Brent Casavant union ioc4_pci_err_addr_l { 3422329b511a97557b293583194037d1f4c71e1504Brent Casavant uint32_t raw; 3522329b511a97557b293583194037d1f4c71e1504Brent Casavant struct { 3622329b511a97557b293583194037d1f4c71e1504Brent Casavant uint32_t valid:1; /* Address captured */ 3722329b511a97557b293583194037d1f4c71e1504Brent Casavant uint32_t master_id:4; /* Unit causing error 3822329b511a97557b293583194037d1f4c71e1504Brent Casavant * 0/1: Serial port 0 TX/RX 3922329b511a97557b293583194037d1f4c71e1504Brent Casavant * 2/3: Serial port 1 TX/RX 4022329b511a97557b293583194037d1f4c71e1504Brent Casavant * 4/5: Serial port 2 TX/RX 4122329b511a97557b293583194037d1f4c71e1504Brent Casavant * 6/7: Serial port 3 TX/RX 4222329b511a97557b293583194037d1f4c71e1504Brent Casavant * 8: ATA/ATAPI 4322329b511a97557b293583194037d1f4c71e1504Brent Casavant * 9-15: Undefined 4422329b511a97557b293583194037d1f4c71e1504Brent Casavant */ 4522329b511a97557b293583194037d1f4c71e1504Brent Casavant uint32_t mul_err:1; /* Multiple errors occurred */ 4622329b511a97557b293583194037d1f4c71e1504Brent Casavant uint32_t addr:26; /* Bits 31-6 of error addr */ 4722329b511a97557b293583194037d1f4c71e1504Brent Casavant } fields; 4822329b511a97557b293583194037d1f4c71e1504Brent Casavant } pci_err_addr_l; 4922329b511a97557b293583194037d1f4c71e1504Brent Casavant uint32_t pci_err_addr_h; /* Bits 63-32 of error addr */ 5022329b511a97557b293583194037d1f4c71e1504Brent Casavant union ioc4_sio_int { 5122329b511a97557b293583194037d1f4c71e1504Brent Casavant uint32_t raw; 5222329b511a97557b293583194037d1f4c71e1504Brent Casavant struct { 5322329b511a97557b293583194037d1f4c71e1504Brent Casavant uint8_t tx_mt:1; /* TX ring buffer empty */ 5422329b511a97557b293583194037d1f4c71e1504Brent Casavant uint8_t rx_full:1; /* RX ring buffer full */ 5522329b511a97557b293583194037d1f4c71e1504Brent Casavant uint8_t rx_high:1; /* RX high-water exceeded */ 5622329b511a97557b293583194037d1f4c71e1504Brent Casavant uint8_t rx_timer:1; /* RX timer has triggered */ 5722329b511a97557b293583194037d1f4c71e1504Brent Casavant uint8_t delta_dcd:1; /* DELTA_DCD seen */ 5822329b511a97557b293583194037d1f4c71e1504Brent Casavant uint8_t delta_cts:1; /* DELTA_CTS seen */ 5922329b511a97557b293583194037d1f4c71e1504Brent Casavant uint8_t intr_pass:1; /* Interrupt pass-through */ 6022329b511a97557b293583194037d1f4c71e1504Brent Casavant uint8_t tx_explicit:1; /* TX, MCW, or delay complete */ 6122329b511a97557b293583194037d1f4c71e1504Brent Casavant } fields[4]; 6222329b511a97557b293583194037d1f4c71e1504Brent Casavant } sio_ir; /* Serial interrupt state */ 6322329b511a97557b293583194037d1f4c71e1504Brent Casavant union ioc4_other_int { 6422329b511a97557b293583194037d1f4c71e1504Brent Casavant uint32_t raw; 6522329b511a97557b293583194037d1f4c71e1504Brent Casavant struct { 6622329b511a97557b293583194037d1f4c71e1504Brent Casavant uint32_t ata_int:1; /* ATA port passthru */ 6722329b511a97557b293583194037d1f4c71e1504Brent Casavant uint32_t ata_memerr:1; /* ATA halted by mem error */ 6822329b511a97557b293583194037d1f4c71e1504Brent Casavant uint32_t memerr:4; /* Serial halted by mem err */ 6922329b511a97557b293583194037d1f4c71e1504Brent Casavant uint32_t kbd_int:1; /* kbd/mouse intr asserted */ 7022329b511a97557b293583194037d1f4c71e1504Brent Casavant uint32_t reserved:16; /* zero */ 7122329b511a97557b293583194037d1f4c71e1504Brent Casavant uint32_t rt_int:1; /* INT_OUT section latch */ 7222329b511a97557b293583194037d1f4c71e1504Brent Casavant uint32_t gen_int:8; /* Intr. from generic pins */ 7322329b511a97557b293583194037d1f4c71e1504Brent Casavant } fields; 7422329b511a97557b293583194037d1f4c71e1504Brent Casavant } other_ir; /* Other interrupt state */ 7522329b511a97557b293583194037d1f4c71e1504Brent Casavant union ioc4_sio_int sio_ies; /* Serial interrupt enable set */ 7622329b511a97557b293583194037d1f4c71e1504Brent Casavant union ioc4_other_int other_ies; /* Other interrupt enable set */ 7722329b511a97557b293583194037d1f4c71e1504Brent Casavant union ioc4_sio_int sio_iec; /* Serial interrupt enable clear */ 7822329b511a97557b293583194037d1f4c71e1504Brent Casavant union ioc4_other_int other_iec; /* Other interrupt enable clear */ 7922329b511a97557b293583194037d1f4c71e1504Brent Casavant union ioc4_sio_cr { 8022329b511a97557b293583194037d1f4c71e1504Brent Casavant uint32_t raw; 8122329b511a97557b293583194037d1f4c71e1504Brent Casavant struct { 8222329b511a97557b293583194037d1f4c71e1504Brent Casavant uint32_t cmd_pulse:4; /* Bytebus strobe width */ 8322329b511a97557b293583194037d1f4c71e1504Brent Casavant uint32_t arb_diag:3; /* PCI bus requester */ 8422329b511a97557b293583194037d1f4c71e1504Brent Casavant uint32_t sio_diag_idle:1; /* Active ser req? */ 8522329b511a97557b293583194037d1f4c71e1504Brent Casavant uint32_t ata_diag_idle:1; /* Active ATA req? */ 8622329b511a97557b293583194037d1f4c71e1504Brent Casavant uint32_t ata_diag_active:1; /* ATA req is winner */ 8722329b511a97557b293583194037d1f4c71e1504Brent Casavant uint32_t reserved:22; /* zero */ 8822329b511a97557b293583194037d1f4c71e1504Brent Casavant } fields; 8922329b511a97557b293583194037d1f4c71e1504Brent Casavant } sio_cr; 9022329b511a97557b293583194037d1f4c71e1504Brent Casavant uint32_t unused1; 9122329b511a97557b293583194037d1f4c71e1504Brent Casavant union ioc4_int_out { 9222329b511a97557b293583194037d1f4c71e1504Brent Casavant uint32_t raw; 9322329b511a97557b293583194037d1f4c71e1504Brent Casavant struct { 9422329b511a97557b293583194037d1f4c71e1504Brent Casavant uint32_t count:16; /* Period control */ 9522329b511a97557b293583194037d1f4c71e1504Brent Casavant uint32_t mode:3; /* Output signal shape */ 9622329b511a97557b293583194037d1f4c71e1504Brent Casavant uint32_t reserved:11; /* zero */ 9722329b511a97557b293583194037d1f4c71e1504Brent Casavant uint32_t diag:1; /* Timebase control */ 9822329b511a97557b293583194037d1f4c71e1504Brent Casavant uint32_t int_out:1; /* Current value */ 9922329b511a97557b293583194037d1f4c71e1504Brent Casavant } fields; 10022329b511a97557b293583194037d1f4c71e1504Brent Casavant } int_out; /* External interrupt output control */ 10122329b511a97557b293583194037d1f4c71e1504Brent Casavant uint32_t unused2; 10222329b511a97557b293583194037d1f4c71e1504Brent Casavant union ioc4_gpcr { 10322329b511a97557b293583194037d1f4c71e1504Brent Casavant uint32_t raw; 10422329b511a97557b293583194037d1f4c71e1504Brent Casavant struct { 10522329b511a97557b293583194037d1f4c71e1504Brent Casavant uint32_t dir:8; /* Pin direction */ 10622329b511a97557b293583194037d1f4c71e1504Brent Casavant uint32_t edge:8; /* Edge/level mode */ 10722329b511a97557b293583194037d1f4c71e1504Brent Casavant uint32_t reserved1:4; /* zero */ 10822329b511a97557b293583194037d1f4c71e1504Brent Casavant uint32_t int_out_en:1; /* INT_OUT enable */ 10922329b511a97557b293583194037d1f4c71e1504Brent Casavant uint32_t reserved2:11; /* zero */ 11022329b511a97557b293583194037d1f4c71e1504Brent Casavant } fields; 11122329b511a97557b293583194037d1f4c71e1504Brent Casavant } gpcr_s; /* Generic PIO control set */ 11222329b511a97557b293583194037d1f4c71e1504Brent Casavant union ioc4_gpcr gpcr_c; /* Generic PIO control clear */ 11322329b511a97557b293583194037d1f4c71e1504Brent Casavant union ioc4_gpdr { 11422329b511a97557b293583194037d1f4c71e1504Brent Casavant uint32_t raw; 11522329b511a97557b293583194037d1f4c71e1504Brent Casavant struct { 11622329b511a97557b293583194037d1f4c71e1504Brent Casavant uint32_t gen_pin:8; /* State of pins */ 11722329b511a97557b293583194037d1f4c71e1504Brent Casavant uint32_t reserved:24; 11822329b511a97557b293583194037d1f4c71e1504Brent Casavant } fields; 11922329b511a97557b293583194037d1f4c71e1504Brent Casavant } gpdr; /* Generic PIO data */ 12022329b511a97557b293583194037d1f4c71e1504Brent Casavant uint32_t unused3; 12122329b511a97557b293583194037d1f4c71e1504Brent Casavant union ioc4_gppr { 12222329b511a97557b293583194037d1f4c71e1504Brent Casavant uint32_t raw; 12322329b511a97557b293583194037d1f4c71e1504Brent Casavant struct { 12422329b511a97557b293583194037d1f4c71e1504Brent Casavant uint32_t gen_pin:1; /* Single pin state */ 12522329b511a97557b293583194037d1f4c71e1504Brent Casavant uint32_t reserved:31; 12622329b511a97557b293583194037d1f4c71e1504Brent Casavant } fields; 12722329b511a97557b293583194037d1f4c71e1504Brent Casavant } gppr[8]; /* Generic PIO pins */ 12822329b511a97557b293583194037d1f4c71e1504Brent Casavant}; 12922329b511a97557b293583194037d1f4c71e1504Brent Casavant 130d4c477ca5448f19afaaf6c0cfd655009ea9e614dBrent Casavant/* Masks for GPCR DIR pins */ 131d4c477ca5448f19afaaf6c0cfd655009ea9e614dBrent Casavant#define IOC4_GPCR_DIR_0 0x01 /* External interrupt output */ 132d4c477ca5448f19afaaf6c0cfd655009ea9e614dBrent Casavant#define IOC4_GPCR_DIR_1 0x02 /* External interrupt input */ 133d4c477ca5448f19afaaf6c0cfd655009ea9e614dBrent Casavant#define IOC4_GPCR_DIR_2 0x04 134d4c477ca5448f19afaaf6c0cfd655009ea9e614dBrent Casavant#define IOC4_GPCR_DIR_3 0x08 /* Keyboard/mouse presence */ 135d4c477ca5448f19afaaf6c0cfd655009ea9e614dBrent Casavant#define IOC4_GPCR_DIR_4 0x10 /* Ser. port 0 xcvr select (0=232, 1=422) */ 136d4c477ca5448f19afaaf6c0cfd655009ea9e614dBrent Casavant#define IOC4_GPCR_DIR_5 0x20 /* Ser. port 1 xcvr select (0=232, 1=422) */ 137d4c477ca5448f19afaaf6c0cfd655009ea9e614dBrent Casavant#define IOC4_GPCR_DIR_6 0x40 /* Ser. port 2 xcvr select (0=232, 1=422) */ 138d4c477ca5448f19afaaf6c0cfd655009ea9e614dBrent Casavant#define IOC4_GPCR_DIR_7 0x80 /* Ser. port 3 xcvr select (0=232, 1=422) */ 139d4c477ca5448f19afaaf6c0cfd655009ea9e614dBrent Casavant 140d4c477ca5448f19afaaf6c0cfd655009ea9e614dBrent Casavant/* Masks for GPCR EDGE pins */ 141d4c477ca5448f19afaaf6c0cfd655009ea9e614dBrent Casavant#define IOC4_GPCR_EDGE_0 0x01 142d4c477ca5448f19afaaf6c0cfd655009ea9e614dBrent Casavant#define IOC4_GPCR_EDGE_1 0x02 /* External interrupt input */ 143d4c477ca5448f19afaaf6c0cfd655009ea9e614dBrent Casavant#define IOC4_GPCR_EDGE_2 0x04 144d4c477ca5448f19afaaf6c0cfd655009ea9e614dBrent Casavant#define IOC4_GPCR_EDGE_3 0x08 145d4c477ca5448f19afaaf6c0cfd655009ea9e614dBrent Casavant#define IOC4_GPCR_EDGE_4 0x10 146d4c477ca5448f19afaaf6c0cfd655009ea9e614dBrent Casavant#define IOC4_GPCR_EDGE_5 0x20 147d4c477ca5448f19afaaf6c0cfd655009ea9e614dBrent Casavant#define IOC4_GPCR_EDGE_6 0x40 148d4c477ca5448f19afaaf6c0cfd655009ea9e614dBrent Casavant#define IOC4_GPCR_EDGE_7 0x80 149d4c477ca5448f19afaaf6c0cfd655009ea9e614dBrent Casavant 150f5befceb5cfecba49fdf61f8e0eb4d453200eac9Brent Casavant#define IOC4_VARIANT_IO9 0x0900 151f5befceb5cfecba49fdf61f8e0eb4d453200eac9Brent Casavant#define IOC4_VARIANT_PCI_RT 0x0901 152f5befceb5cfecba49fdf61f8e0eb4d453200eac9Brent Casavant#define IOC4_VARIANT_IO10 0x1000 153f5befceb5cfecba49fdf61f8e0eb4d453200eac9Brent Casavant 154d4c477ca5448f19afaaf6c0cfd655009ea9e614dBrent Casavant/* One of these per IOC4 */ 15522329b511a97557b293583194037d1f4c71e1504Brent Casavantstruct ioc4_driver_data { 15622329b511a97557b293583194037d1f4c71e1504Brent Casavant struct list_head idd_list; 15722329b511a97557b293583194037d1f4c71e1504Brent Casavant unsigned long idd_bar0; 15822329b511a97557b293583194037d1f4c71e1504Brent Casavant struct pci_dev *idd_pdev; 15922329b511a97557b293583194037d1f4c71e1504Brent Casavant const struct pci_device_id *idd_pci_id; 160fb136e97840872638cb08588c4c9b9fff7f7c456Al Viro struct ioc4_misc_regs __iomem *idd_misc_regs; 161d4c477ca5448f19afaaf6c0cfd655009ea9e614dBrent Casavant unsigned long count_period; 16222329b511a97557b293583194037d1f4c71e1504Brent Casavant void *idd_serial_data; 163f5befceb5cfecba49fdf61f8e0eb4d453200eac9Brent Casavant unsigned int idd_variant; 16422329b511a97557b293583194037d1f4c71e1504Brent Casavant}; 16522329b511a97557b293583194037d1f4c71e1504Brent Casavant 16622329b511a97557b293583194037d1f4c71e1504Brent Casavant/* One per submodule */ 16722329b511a97557b293583194037d1f4c71e1504Brent Casavantstruct ioc4_submodule { 16822329b511a97557b293583194037d1f4c71e1504Brent Casavant struct list_head is_list; 16922329b511a97557b293583194037d1f4c71e1504Brent Casavant char *is_name; 17022329b511a97557b293583194037d1f4c71e1504Brent Casavant struct module *is_owner; 17122329b511a97557b293583194037d1f4c71e1504Brent Casavant int (*is_probe) (struct ioc4_driver_data *); 17222329b511a97557b293583194037d1f4c71e1504Brent Casavant int (*is_remove) (struct ioc4_driver_data *); 17322329b511a97557b293583194037d1f4c71e1504Brent Casavant}; 17422329b511a97557b293583194037d1f4c71e1504Brent Casavant 17522329b511a97557b293583194037d1f4c71e1504Brent Casavant#define IOC4_NUM_CARDS 8 /* max cards per partition */ 17622329b511a97557b293583194037d1f4c71e1504Brent Casavant 17722329b511a97557b293583194037d1f4c71e1504Brent Casavant/********************************** 17822329b511a97557b293583194037d1f4c71e1504Brent Casavant * Functions needed by submodules * 17922329b511a97557b293583194037d1f4c71e1504Brent Casavant **********************************/ 18022329b511a97557b293583194037d1f4c71e1504Brent Casavant 18122329b511a97557b293583194037d1f4c71e1504Brent Casavantextern int ioc4_register_submodule(struct ioc4_submodule *); 18222329b511a97557b293583194037d1f4c71e1504Brent Casavantextern void ioc4_unregister_submodule(struct ioc4_submodule *); 18322329b511a97557b293583194037d1f4c71e1504Brent Casavant 18422329b511a97557b293583194037d1f4c71e1504Brent Casavant#endif /* _LINUX_IOC4_H */ 185