sys/dev/bhnd/bcma/bcma_eromvar.h

   1 /*-
   2  * Copyright (c) 2015 Landon Fuller <landon@landonf.org>
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer,
  10  *    without modification.
  11  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
  12  *    similar to the "NO WARRANTY" disclaimer below ("Disclaimer") and any
  13  *    redistribution must be conditioned upon including a substantially
  14  *    similar Disclaimer requirement for further binary redistribution.
  15  *
  16  * NO WARRANTY
  17  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  18  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  19  * LIMITED TO, THE IMPLIED WARRANTIES OF NONINFRINGEMENT, MERCHANTIBILITY
  20  * AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
  21  * THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY,
  22  * OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  23  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  24  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
  25  * IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  26  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
  27  * THE POSSIBILITY OF SUCH DAMAGES.
  28  *
  29  * $FreeBSD$
  30  */
  31
  32 #ifndef _BCMA_BCMA_EROMVAR_H_
  33 #define _BCMA_BCMA_EROMVAR_H_
  34
  35 #include <dev/bhnd/bhnd.h>
  36 #include <dev/bhnd/bhnd_erom.h>
  37
  38 #include "bcmavar.h"
  39
  40 struct bcma_erom;
  41
  42 int     bcma_erom_next_corecfg(struct bcma_erom *sc,
  43             struct bcma_corecfg **result);
  44
  45 /** EROM core descriptor. */
  46 struct bcma_erom_core {
  47         uint16_t        vendor;         /**< core's designer */
  48         uint16_t        device;         /**< core's device identifier */
  49         uint16_t        rev;            /**< core's hardware revision */
  50         u_long          num_mport;      /**< number of master port descriptors */
  51         u_long          num_dport;      /**< number of slave port descriptors */
  52         u_long          num_mwrap;      /**< number of master wrapper slave port descriptors */
  53         u_long          num_swrap;      /**< number of slave wrapper slave port descriptors */
  54 };
  55
  56 /** EROM master port descriptor. */
  57 struct bcma_erom_mport {
  58         uint8_t         port_num;       /**< the port number (bus-unique) */
  59         uint8_t         port_vid;       /**< the port VID. A single physical
  60                                              master port may have multiple VIDs;
  61                                              the canonical port address is
  62                                              composed of the port number + the
  63                                              port VID */
  64 };
  65
  66 /** EROM slave port region descriptor. */
  67 struct bcma_erom_sport_region {
  68         uint8_t         region_port;    /**< the slave port mapping this region */
  69         uint8_t         region_type;    /**< the mapping port's type */
  70         bhnd_addr_t     base_addr;      /**< region base address */
  71         bhnd_addr_t     size;           /**< region size */
  72 };
  73
  74 #endif /* _BCMA_BCMA_EROMVAR_H_ */