sys/dev/cardbus/cardbusvar.h

   1 /*-
   2  * Copyright (c) 2008, M. Warner Losh
   3  * Copyright (c) 2000,2001 Jonathan Chen.
   4  * All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions
   8  * are met:
   9  * 1. Redistributions of source code must retain the above copyright
  10  *    notice, this list of conditions and the following disclaimer.
  11  * 2. Redistributions in binary form must reproduce the above copyright
  12  *    notice, this list of conditions and the following disclaimer in the
  13  *    documentation and/or other materials provided with the distribution.
  14  *
  15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  16  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  18  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  19  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  20  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  21  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  22  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  23  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  24  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  25  * SUCH DAMAGE.
  26  *
  27  * $FreeBSD$
  28  */
  29
  30 /*
  31  * Structure definitions for the Cardbus Bus driver
  32  */
  33
  34 /*
  35  * Static copy of the CIS buffer.  Technically, you aren't supposed
  36  * to do this.  In practice, however, it works well.
  37  */
  38 struct cis_buffer
  39 {
  40         size_t  len;                    /* Actual length of the CIS */
  41         uint8_t buffer[2040];           /* small enough to be 2k */
  42 };
  43
  44 /*
  45  * Per child information for the PCI device.  Cardbus layers on some
  46  * additional data.
  47  */
  48 struct cardbus_devinfo
  49 {
  50         struct pci_devinfo pci;
  51         uint8_t        mprefetchable; /* bit mask of prefetchable BARs */
  52         uint8_t        mbelow1mb; /* bit mask of BARs which require below 1Mb */
  53         uint16_t        mfrid;          /* manufacturer id */
  54         uint16_t        prodid;         /* product id */
  55         u_int           funcid;         /* function id */
  56         union {
  57                 struct {
  58                         uint8_t nid[6];         /* MAC address */
  59                 } lan;
  60         } funce;
  61         uint32_t        fepresent;      /* bit mask of funce values present */
  62         struct cdev     *sc_cisdev;
  63         struct cis_buffer sc_cis;
  64 };
  65
  66 /*
  67  * Per cardbus soft info.  Not sure why we even keep this around...
  68  */
  69 struct cardbus_softc
  70 {
  71         device_t        sc_dev;
  72 };
  73
  74 /*
  75  * Per node callback structures.
  76  */
  77 struct tuple_callbacks;
  78 typedef int (tuple_cb) (device_t cbdev, device_t child, int id, int len,
  79                  uint8_t *tupledata, uint32_t start, uint32_t *off,
  80                  struct tuple_callbacks *info, void *);
  81 struct tuple_callbacks {
  82         int     id;
  83         char    *name;
  84         tuple_cb *func;
  85 };
  86
  87 int     cardbus_device_create(struct cardbus_softc *sc,
  88             struct cardbus_devinfo *devi, device_t parent, device_t child);
  89 int     cardbus_device_destroy(struct cardbus_devinfo *devi);
  90 int     cardbus_parse_cis(device_t cbdev, device_t child,
  91             struct tuple_callbacks *callbacks, void *);