sys/dev/cardbus/cardbusvar.h

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