sys/bus/pccard/slot.h

   1 /*
   2  *      Slot structures for PC-CARD interface.
   3  *      Each slot has a controller specific structure
   4  *      attached to it. A slot number allows
   5  *      mapping from the character device to the
   6  *      slot structure. This is separate to the
   7  *      controller slot number to allow multiple controllers
   8  *      to be accessed.
   9  *-------------------------------------------------------------------------
  10  *
  11  * Copyright (c) 1995 Andrew McRae.  All rights reserved.
  12  *
  13  * Redistribution and use in source and binary forms, with or without
  14  * modification, are permitted provided that the following conditions
  15  * are met:
  16  * 1. Redistributions of source code must retain the above copyright
  17  *    notice, this list of conditions and the following disclaimer.
  18  * 2. Redistributions in binary form must reproduce the above copyright
  19  *    notice, this list of conditions and the following disclaimer in the
  20  *    documentation and/or other materials provided with the distribution.
  21  * 3. The name of the author may not be used to endorse or promote products
  22  *    derived from this software without specific prior written permission.
  23  *
  24  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  25  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  26  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  27  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  28  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  29  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  30  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  31  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  32  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  33  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  34  *
  35  * $FreeBSD: src/sys/pccard/slot.h,v 1.25.2.5 2002/09/22 20:26:58 imp Exp $
  36  * $DragonFly: src/sys/bus/pccard/Attic/slot.h,v 1.3 2004/02/11 15:24:30 joerg Exp $
  37  */
  38
  39 #ifndef _PCCARD_SLOT_H
  40 #define _PCCARD_SLOT_H
  41
  42 /*
  43  * Normally we shouldn't include stuff here, but we're trying to be
  44  * compatible with the long, dark hand of the past.
  45  */
  46 #include <sys/param.h>
  47 #include <sys/bus.h>
  48 #include <machine/bus.h>
  49 #include <sys/rman.h>
  50 #include <machine/resource.h>
  51 #include <sys/select.h>
  52
  53 /*
  54  *      Controller data - Specific to each slot controller.
  55  */
  56 struct slot;
  57 struct slot_ctrl {
  58         void    (*mapirq)(struct slot *, int);
  59                                 /* Map irq */
  60         int     (*mapmem)(struct slot *, int);
  61                                 /* Map memory */
  62         int     (*mapio)(struct slot *, int);
  63                                 /* Map io */
  64         void    (*reset)(void *);
  65                                 /* init */
  66         void    (*disable)(struct slot *);
  67                                 /* Disable slot */
  68         int     (*power)(struct slot *);
  69                                 /* Set power values */
  70         int     (*ioctl)(struct slot *, int, caddr_t);
  71                                 /* ioctl to lower level */
  72         void    (*resume)(struct slot *);
  73                                 /* suspend/resume support */
  74         int     maxmem;         /* Number of allowed memory windows */
  75         int     maxio;          /* Number of allowed I/O windows */
  76 };
  77
  78 /*
  79  *      Device structure for cards. Each card may have one
  80  *      or more pccard drivers attached to it; each driver is assumed
  81  *      to require at most one interrupt handler, one I/O block
  82  *      and one memory block. This structure is used to link the different
  83  *      devices together.
  84  */
  85 struct pccard_devinfo {
  86         uint8_t         name[128];
  87         int             running;        /* Current state of driver */
  88         uint8_t         misc[DEV_MISC_LEN]; /* For any random info */
  89         uint8_t         manufstr[DEV_MAX_CIS_LEN];
  90         uint8_t         versstr[DEV_MAX_CIS_LEN];
  91         uint32_t        manufacturer;   /* Manufacturer ID */
  92         uint32_t        product;        /* Product ID */
  93         uint32_t        prodext;        /* Product ID (extended) */
  94         struct slot     *slt;           /* Back pointer to slot */
  95         struct resource_list resources;
  96 };
  97
  98 /*
  99  *      Per-slot structure.
 100  */
 101 struct slot {
 102         int slotnum;                    /* Slot number */
 103         int flags;                      /* Slot flags (see below) */
 104         int rwmem;                      /* Read/write flags */
 105         int irq;                        /* IRQ allocated (0 = none) */
 106
 107         /*
 108          *      flags.
 109          */
 110         unsigned int    insert_seq;     /* Firing up under the card */
 111         struct callout_handle insert_ch;/* Insert event timeout handle */
 112         struct callout_handle poff_ch;  /* Power Off timeout handle */
 113
 114         enum cardstate  state, laststate; /* Current/last card states */
 115         struct selinfo  selp;           /* Info for select */
 116         struct mem_desc mem[NUM_MEM_WINDOWS];   /* Memory windows */
 117         struct io_desc  io[NUM_IO_WINDOWS];     /* I/O windows */
 118         struct power    pwr;            /* Power values */
 119         struct slot_ctrl *ctrl;         /* Per-controller data */
 120         void            *cdata;         /* Controller specific data */
 121         int             pwr_off_pending;/* Power status of slot */
 122         device_t        dev;            /* Config system device. */
 123         dev_t           d;              /* fs device */
 124 };
 125
 126 #define PCCARD_DEVICE2SOFTC(d)  ((struct slot *) device_get_softc(d))
 127 #define PCCARD_DEV2SOFTC(d)     ((struct slot *) (d)->si_drv1)
 128
 129 enum card_event { card_removed, card_inserted, card_deactivated };
 130
 131 struct slot     *pccard_init_slot(device_t, struct slot_ctrl *);
 132 void             pccard_event(struct slot *, enum card_event);
 133 int              pccard_suspend(device_t);
 134 int              pccard_resume(device_t);
 135
 136 #endif /* !_PCCARD_SLOT_H */