sys/dev/cardbus/cardbusvar.h

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