1/* header file for DIO boards for the HP300 architecture. 2 * Maybe this should handle DIO-II later? 3 * The general structure of this is vaguely based on how 4 * the Amiga port handles Zorro boards. 5 * Copyright (C) Peter Maydell 05/1998 <pmaydell@chiark.greenend.org.uk> 6 * Converted to driver model Jochen Friedrich <jochen@scram.de> 7 * 8 * The board IDs are from the NetBSD kernel, which for once provided 9 * helpful comments... 10 * 11 * This goes with drivers/dio/dio.c 12 */ 13 14#ifndef _LINUX_DIO_H 15#define _LINUX_DIO_H 16 17/* The DIO boards in a system are distinguished by 'select codes' which 18 * range from 0-63 (DIO) and 132-255 (DIO-II). 19 * The DIO board with select code sc is located at physical address 20 * 0x600000 + sc * 0x10000 21 * So DIO cards cover [0x600000-0x800000); the areas [0x200000-0x400000) and 22 * [0x800000-0x1000000) are for additional space required by things 23 * like framebuffers. [0x400000-0x600000) is for miscellaneous internal I/O. 24 * On Linux, this is currently all mapped into the virtual address space 25 * at 0xf0000000 on bootup. 26 * DIO-II boards are at 0x1000000 + (sc - 132) * 0x400000 27 * which is address range [0x1000000-0x20000000) -- too big to map completely, 28 * so currently we just don't handle DIO-II boards. It wouldn't be hard to 29 * do with ioremap() though. 30 */ 31 32#include <linux/device.h> 33 34#ifdef __KERNEL__ 35 36#include <asm/hp300hw.h> 37 38typedef __u16 dio_id; 39 40 /* 41 * DIO devices 42 */ 43 44struct dio_dev { 45 struct dio_bus *bus; 46 dio_id id; 47 int scode; 48 struct dio_driver *driver; /* which driver has allocated this device */ 49 struct device dev; /* Generic device interface */ 50 u8 ipl; 51 char name[64]; 52 struct resource resource; 53}; 54 55#define to_dio_dev(n) container_of(n, struct dio_dev, dev) 56 57 /* 58 * DIO bus 59 */ 60 61struct dio_bus { 62 struct list_head devices; /* list of devices on this bus */ 63 unsigned int num_resources; /* number of resources */ 64 struct resource resources[2]; /* address space routed to this bus */ 65 struct device dev; 66 char name[10]; 67}; 68 69extern struct dio_bus dio_bus; /* Single DIO bus */ 70extern struct bus_type dio_bus_type; 71 72 /* 73 * DIO device IDs 74 */ 75 76struct dio_device_id { 77 dio_id id; /* Device ID or DIO_WILDCARD */ 78 unsigned long driver_data; /* Data private to the driver */ 79}; 80 81 /* 82 * DIO device drivers 83 */ 84 85struct dio_driver { 86 struct list_head node; 87 char *name; 88 const struct dio_device_id *id_table; /* NULL if wants all devices */ 89 int (*probe)(struct dio_dev *z, const struct dio_device_id *id); 90/* New device inserted */ 91 void (*remove)(struct dio_dev *z); /* Device removed (NULL if not a hot-plug capable driver) */ 92 struct device_driver driver; 93}; 94 95#define to_dio_driver(drv) container_of(drv, struct dio_driver, driver) 96 97/* DIO/DIO-II boards all have the following 8bit registers. 98 * These are offsets from the base of the device. 99 */ 100#define DIO_IDOFF 0x01 /* primary device ID */ 101#define DIO_IPLOFF 0x03 /* interrupt priority level */ 102#define DIO_SECIDOFF 0x15 /* secondary device ID */ 103#define DIOII_SIZEOFF 0x101 /* device size, DIO-II only */ 104#define DIO_VIRADDRBASE 0xf0000000UL /* vir addr where IOspace is mapped */ 105 106#define DIO_BASE 0x600000 /* start of DIO space */ 107#define DIO_END 0x1000000 /* end of DIO space */ 108#define DIO_DEVSIZE 0x10000 /* size of a DIO device */ 109 110#define DIOII_BASE 0x01000000 /* start of DIO-II space */ 111#define DIOII_END 0x20000000 /* end of DIO-II space */ 112#define DIOII_DEVSIZE 0x00400000 /* size of a DIO-II device */ 113 114/* Highest valid select code. If we add DIO-II support this should become 115 * 256 for everything except HP320, which only has DIO. 116 */ 117#define DIO_SCMAX (hp300_model == HP_320 ? 32 : 256) 118#define DIOII_SCBASE 132 /* lowest DIO-II select code */ 119#define DIO_SCINHOLE(scode) (((scode) >= 32) && ((scode) < DIOII_SCBASE)) 120#define DIO_ISDIOII(scode) ((scode) >= 132 && (scode) < 256) 121 122/* macros to read device IDs, given base address */ 123#define DIO_ID(baseaddr) in_8((baseaddr) + DIO_IDOFF) 124#define DIO_SECID(baseaddr) in_8((baseaddr) + DIO_SECIDOFF) 125 126/* extract the interrupt level */ 127#define DIO_IPL(baseaddr) (((in_8((baseaddr) + DIO_IPLOFF) >> 4) & 0x03) + 3) 128 129/* find the size of a DIO-II board's address space. 130 * DIO boards are all fixed length. 131 */ 132#define DIOII_SIZE(baseaddr) ((in_8((baseaddr) + DIOII_SIZEOFF) + 1) * 0x100000) 133 134/* general purpose macro for both DIO and DIO-II */ 135#define DIO_SIZE(scode, base) (DIO_ISDIOII((scode)) ? DIOII_SIZE((base)) : DIO_DEVSIZE) 136 137/* The hardware has primary and secondary IDs; we encode these in a single 138 * int as PRIMARY ID & (SECONDARY ID << 8). 139 * In practice this is only important for framebuffers, 140 * and everybody else just sets ID fields equal to the DIO_ID_FOO value. 141 */ 142#define DIO_ENCODE_ID(pr,sec) ((((int)sec & 0xff) << 8) | ((int)pr & 0xff)) 143/* macro to determine whether a given primary ID requires a secondary ID byte */ 144#define DIO_NEEDSSECID(id) ((id) == DIO_ID_FBUFFER) 145#define DIO_WILDCARD 0xff 146 147/* Now a whole slew of macros giving device IDs and descriptive strings: */ 148#define DIO_ID_DCA0 0x02 /* 98644A serial */ 149#define DIO_DESC_DCA0 "98644A DCA0 serial" 150#define DIO_ID_DCA0REM 0x82 /* 98644A serial */ 151#define DIO_DESC_DCA0REM "98644A DCA0REM serial" 152#define DIO_ID_DCA1 0x42 /* 98644A serial */ 153#define DIO_DESC_DCA1 "98644A DCA1 serial" 154#define DIO_ID_DCA1REM 0xc2 /* 98644A serial */ 155#define DIO_DESC_DCA1REM "98644A DCA1REM serial" 156#define DIO_ID_DCM 0x05 /* 98642A serial MUX */ 157#define DIO_DESC_DCM "98642A DCM serial MUX" 158#define DIO_ID_DCMREM 0x85 /* 98642A serial MUX */ 159#define DIO_DESC_DCMREM "98642A DCMREM serial MUX" 160#define DIO_ID_LAN 0x15 /* 98643A LAN */ 161#define DIO_DESC_LAN "98643A LANCE ethernet" 162#define DIO_ID_FHPIB 0x08 /* 98625A/98625B fast HP-IB */ 163#define DIO_DESC_FHPIB "98625A/98625B fast HPIB" 164#define DIO_ID_NHPIB 0x01 /* 98624A HP-IB (normal ie slow) */ 165#define DIO_DESC_NHPIB "98624A HPIB" 166#define DIO_ID_SCSI0 0x07 /* 98265A SCSI */ 167#define DIO_DESC_SCSI0 "98265A SCSI0" 168#define DIO_ID_SCSI1 0x27 /* ditto */ 169#define DIO_DESC_SCSI1 "98265A SCSI1" 170#define DIO_ID_SCSI2 0x47 /* ditto */ 171#define DIO_DESC_SCSI2 "98265A SCSI2" 172#define DIO_ID_SCSI3 0x67 /* ditto */ 173#define DIO_DESC_SCSI3 "98265A SCSI3" 174#define DIO_ID_FBUFFER 0x39 /* framebuffer: flavour is distinguished by secondary ID */ 175#define DIO_DESC_FBUFFER "bitmapped display" 176/* the NetBSD kernel source is a bit unsure as to what these next IDs actually do :-> */ 177#define DIO_ID_MISC0 0x03 /* 98622A */ 178#define DIO_DESC_MISC0 "98622A" 179#define DIO_ID_MISC1 0x04 /* 98623A */ 180#define DIO_DESC_MISC1 "98623A" 181#define DIO_ID_PARALLEL 0x06 /* internal parallel */ 182#define DIO_DESC_PARALLEL "internal parallel" 183#define DIO_ID_MISC2 0x09 /* 98287A keyboard */ 184#define DIO_DESC_MISC2 "98287A keyboard" 185#define DIO_ID_MISC3 0x0a /* HP98635A FP accelerator */ 186#define DIO_DESC_MISC3 "HP98635A FP accelerator" 187#define DIO_ID_MISC4 0x0b /* timer */ 188#define DIO_DESC_MISC4 "timer" 189#define DIO_ID_MISC5 0x12 /* 98640A */ 190#define DIO_DESC_MISC5 "98640A" 191#define DIO_ID_MISC6 0x16 /* 98659A */ 192#define DIO_DESC_MISC6 "98659A" 193#define DIO_ID_MISC7 0x19 /* 237 display */ 194#define DIO_DESC_MISC7 "237 display" 195#define DIO_ID_MISC8 0x1a /* quad-wide card */ 196#define DIO_DESC_MISC8 "quad-wide card" 197#define DIO_ID_MISC9 0x1b /* 98253A */ 198#define DIO_DESC_MISC9 "98253A" 199#define DIO_ID_MISC10 0x1c /* 98627A */ 200#define DIO_DESC_MISC10 "98253A" 201#define DIO_ID_MISC11 0x1d /* 98633A */ 202#define DIO_DESC_MISC11 "98633A" 203#define DIO_ID_MISC12 0x1e /* 98259A */ 204#define DIO_DESC_MISC12 "98259A" 205#define DIO_ID_MISC13 0x1f /* 8741 */ 206#define DIO_DESC_MISC13 "8741" 207#define DIO_ID_VME 0x31 /* 98577A VME adapter */ 208#define DIO_DESC_VME "98577A VME adapter" 209#define DIO_ID_DCL 0x34 /* 98628A serial */ 210#define DIO_DESC_DCL "98628A DCL serial" 211#define DIO_ID_DCLREM 0xb4 /* 98628A serial */ 212#define DIO_DESC_DCLREM "98628A DCLREM serial" 213/* These are the secondary IDs for the framebuffers */ 214#define DIO_ID2_GATORBOX 0x01 /* 98700/98710 "gatorbox" */ 215#define DIO_DESC2_GATORBOX "98700/98710 \"gatorbox\" display" 216#define DIO_ID2_TOPCAT 0x02 /* 98544/98545/98547 "topcat" */ 217#define DIO_DESC2_TOPCAT "98544/98545/98547 \"topcat\" display" 218#define DIO_ID2_RENAISSANCE 0x04 /* 98720/98721 "renaissance" */ 219#define DIO_DESC2_RENAISSANCE "98720/98721 \"renaissance\" display" 220#define DIO_ID2_LRCATSEYE 0x05 /* lowres "catseye" */ 221#define DIO_DESC2_LRCATSEYE "low-res catseye display" 222#define DIO_ID2_HRCCATSEYE 0x06 /* highres colour "catseye" */ 223#define DIO_DESC2_HRCCATSEYE "high-res color catseye display" 224#define DIO_ID2_HRMCATSEYE 0x07 /* highres mono "catseye" */ 225#define DIO_DESC2_HRMCATSEYE "high-res mono catseye display" 226#define DIO_ID2_DAVINCI 0x08 /* 98730/98731 "davinci" */ 227#define DIO_DESC2_DAVINCI "98730/98731 \"davinci\" display" 228#define DIO_ID2_XXXCATSEYE 0x09 /* "catseye" */ 229#define DIO_DESC2_XXXCATSEYE "catseye display" 230#define DIO_ID2_HYPERION 0x0e /* A1096A "hyperion" */ 231#define DIO_DESC2_HYPERION "A1096A \"hyperion\" display" 232#define DIO_ID2_XGENESIS 0x0b /* "x-genesis"; no NetBSD support */ 233#define DIO_DESC2_XGENESIS "\"x-genesis\" display" 234#define DIO_ID2_TIGER 0x0c /* "tiger"; no NetBSD support */ 235#define DIO_DESC2_TIGER "\"tiger\" display" 236#define DIO_ID2_YGENESIS 0x0d /* "y-genesis"; no NetBSD support */ 237#define DIO_DESC2_YGENESIS "\"y-genesis\" display" 238/* if you add new IDs then you should tell dio.c about them so it can 239 * identify them... 240 */ 241 242extern int dio_find(int deviceid); 243extern unsigned long dio_scodetophysaddr(int scode); 244extern void dio_create_sysfs_dev_files(struct dio_dev *); 245 246/* New-style probing */ 247extern int dio_register_driver(struct dio_driver *); 248extern void dio_unregister_driver(struct dio_driver *); 249extern const struct dio_device_id *dio_match_device(const struct dio_device_id *ids, const struct dio_dev *z); 250static inline struct dio_driver *dio_dev_driver(const struct dio_dev *d) 251{ 252 return d->driver; 253} 254 255#define dio_resource_start(d) ((d)->resource.start) 256#define dio_resource_end(d) ((d)->resource.end) 257#define dio_resource_len(d) ((d)->resource.end-(d)->resource.start+1) 258#define dio_resource_flags(d) ((d)->resource.flags) 259 260#define dio_request_device(d, name) \ 261 request_mem_region(dio_resource_start(d), dio_resource_len(d), name) 262#define dio_release_device(d) \ 263 release_mem_region(dio_resource_start(d), dio_resource_len(d)) 264 265/* Similar to the helpers above, these manipulate per-dio_dev 266 * driver-specific data. They are really just a wrapper around 267 * the generic device structure functions of these calls. 268 */ 269static inline void *dio_get_drvdata (struct dio_dev *d) 270{ 271 return dev_get_drvdata(&d->dev); 272} 273 274static inline void dio_set_drvdata (struct dio_dev *d, void *data) 275{ 276 dev_set_drvdata(&d->dev, data); 277} 278 279#endif /* __KERNEL__ */ 280#endif /* ndef _LINUX_DIO_H */ 281