1/* 2 * Include file for PCMCIA user process interface 3 * 4 *------------------------------------------------------------------------- 5 */ 6/*- 7 * SPDX-License-Identifier: BSD-3-Clause 8 * 9 * Copyright (c) 1995 Andrew McRae. All rights reserved. 10 * 11 * Redistribution and use in source and binary forms, with or without 12 * modification, are permitted provided that the following conditions 13 * are met: 14 * 1. Redistributions of source code must retain the above copyright 15 * notice, this list of conditions and the following disclaimer. 16 * 2. Redistributions in binary form must reproduce the above copyright 17 * notice, this list of conditions and the following disclaimer in the 18 * documentation and/or other materials provided with the distribution. 19 * 3. The name of the author may not be used to endorse or promote products 20 * derived from this software without specific prior written permission. 21 * 22 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 23 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 24 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 25 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 26 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 27 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 28 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 29 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 30 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 31 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 32 */ 33 34 35#ifndef _PCCARD_CARDINFO_H_ 36#define _PCCARD_CARDINFO_H_ 37 38#ifndef _KERNEL 39#include <sys/types.h> 40#endif 41#include <sys/ioccom.h> 42 43#define PIOCGSTATE _IOR('P', 1, struct slotstate) /* Get slot state */ 44#define PIOCGMEM _IOWR('P', 2, struct mem_desc) /* Get memory map */ 45#define PIOCSMEM _IOW('P', 3, struct mem_desc) /* Set memory map */ 46#define PIOCGIO _IOWR('P', 4, struct io_desc) /* Get I/O map */ 47#define PIOCSIO _IOW('P', 5, struct io_desc) /* Set I/O map */ 48#define PIOCSDRV _IOWR('P', 6, struct dev_desc) /* Set driver */ 49#define PIOCRWFLAG _IOW('P', 7, int) /* Set flags for drv use */ 50#define PIOCRWMEM _IOWR('P', 8, unsigned long) /* Set mem for drv use */ 51#define PIOCSPOW _IOW('P', 9, struct power) /* Set power structure */ 52#define PIOCSVIR _IOW('P', 10, int) /* Virtual insert/remove */ 53#define PIOCSBEEP _IOW('P', 11, int) /* Select Beep */ 54#define PIOCSRESOURCE _IOWR('P', 12, struct pccard_resource) /* get resource info */ 55/* 56 * Debug codes. 57 */ 58#define PIOCGREG _IOWR('P',100, struct pcic_reg) /* get reg */ 59#define PIOCSREG _IOW('P', 101, struct pcic_reg) /* Set reg */ 60 61/* 62 * Slot states for PIOCGSTATE 63 * 64 * Here's a state diagram of all the possible states: 65 * 66 * power x 1 67 * ------------------- 68 * / \ 69 * / v 70 * resume +----------+ power x 0 +----------+ 71 * ------->| inactive |<--------------| filled | 72 * / +----------+ +----------+ 73 * / / \ ^ | 74 * nil <--------- \ insert or | | suspend or 75 * suspend \ power x 1 | | eject 76 * \ | v 77 * \ +----------+ 78 * ----------->| empty | 79 * eject +----------+ 80 * 81 * Note, the above diagram is for the state. On suspend, the laststate 82 * gets set to suspend to tell pccardd what happened. Also the nil state 83 * means that when the no state change has happened. Note: if you eject 84 * while suspended in the inactive state, you will return to the 85 * empty state if you do not insert a new card and to the inactive state 86 * if you do insert a new card. 87 * 88 * Some might argue that inactive should be sticky forever and 89 * eject/insert shouldn't take it out of that state. They might be 90 * right. On the other hand, some would argue that eject resets all 91 * state. They might be right. They both can't be right. The above 92 * represents a reasonable compromise between the two. 93 * 94 * Some bridges allow one to query to see if the card was changed while 95 * we were suspended. Others do not. We make no use of this functionality 96 * at this time. 97 */ 98enum cardstate { noslot, empty, suspend, filled, inactive }; 99 100/* 101 * Descriptor structure for memory map. 102 */ 103struct mem_desc { 104 int window; /* Memory map window number (0-4) */ 105 int flags; /* Flags - see below */ 106 caddr_t start; /* System memory start */ 107 int size; /* Size of memory area */ 108 unsigned long card; /* Card memory address */ 109}; 110 111#define MDF_16BITS 0x01 /* Memory is 16 bits wide */ 112#define MDF_ZEROWS 0x02 /* Set no wait states for memory */ 113#define MDF_WS0 0x04 /* Wait state flags */ 114#define MDF_WS1 0x08 115#define MDF_ATTR 0x10 /* Memory is attribute memory */ 116#define MDF_WP 0x20 /* Write protect memory */ 117#define MDF_ACTIVE 0x40 /* Context active (read-only) */ 118 119/* 120 * Descriptor structure for I/O map 121 */ 122struct io_desc { 123 int window; /* I/O map number (0-1) */ 124 int flags; /* Flags - see below */ 125 int start; /* I/O port start */ 126 int size; /* Number of port addresses */ 127}; 128 129#define IODF_WS 0x01 /* Set wait states for 16 bit I/O access */ 130#define IODF_16BIT 0x02 /* I/O access are 16 bit */ 131#define IODF_CS16 0x04 /* Allow card selection of 16 bit access */ 132#define IODF_ZEROWS 0x08 /* No wait states for 8 bit I/O */ 133#define IODF_ACTIVE 0x10 /* Context active (read-only) */ 134 135/* 136 * Device descriptor for allocation of driver. 137 */ 138#define DEV_MISC_LEN 36 139#define DEV_MAX_CIS_LEN 40 140struct dev_desc { 141 char name[16]; /* Driver name */ 142 int unit; /* Driver unit number */ 143 unsigned long mem; /* Memory address of driver */ 144 int memsize; /* Memory size (if used) */ 145 int iobase; /* base of I/O ports */ 146 int iosize; /* Length of I/O ports */ 147 int irqmask; /* Interrupt number(s) to allocate */ 148 int flags; /* Device flags */ 149 uint8_t misc[DEV_MISC_LEN]; /* For any random info */ 150 uint8_t manufstr[DEV_MAX_CIS_LEN]; 151 uint8_t versstr[DEV_MAX_CIS_LEN]; 152 uint8_t cis3str[DEV_MAX_CIS_LEN]; 153 uint8_t cis4str[DEV_MAX_CIS_LEN]; 154 uint32_t manufacturer; /* Manufacturer ID */ 155 uint32_t product; /* Product ID */ 156 uint32_t prodext; /* Product ID (extended) */ 157}; 158#define DEV_DESC_HAS_SIZE 1 159 160struct pcic_reg { 161 unsigned char reg; 162 unsigned char value; 163}; 164 165/* 166 * Slot information. Used to read current status of slot. 167 */ 168struct slotstate { 169 enum cardstate state; /* Current state of slot */ 170 enum cardstate laststate; /* Previous state of slot */ 171 int maxmem; /* Max allowed memory windows */ 172 int maxio; /* Max allowed I/O windows */ 173 int irqs; /* Bitmap of IRQs allowed */ 174 int flags; /* Capability flags */ 175}; 176 177/* 178 * The power values are in volts * 10, e.g. 5V is 50, 3.3V is 33. 179 */ 180struct power { 181 int vcc; 182 int vpp; 183}; 184 185/* 186 * The PC-Card resource IOC_GET_RESOURCE_RANGE 187 */ 188struct pccard_resource { 189 int type; 190 u_long size; 191 u_long min; 192 u_long max; 193 u_long resource_addr; 194}; 195 196 197/* 198 * Other system limits 199 */ 200#define MAXSLOT 16 201#define NUM_MEM_WINDOWS 10 202#define NUM_IO_WINDOWS 6 203#define CARD_DEVICE "/dev/card%d" /* String for snprintf */ 204#define PCCARD_MEMSIZE (4*1024) 205 206#endif /* !_PCCARD_CARDINFO_H_ */ 207