sys/dev/bhnd/nvram/bhnd_nvram.h

   1 /*-
   2  * Copyright (c) 2015-2016 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 _BHND_NVRAM_BHND_NVRAM_H_
  33 #define _BHND_NVRAM_BHND_NVRAM_H_
  34
  35 #ifdef _KERNEL
  36 #include <sys/types.h>
  37 #else /* !_KERNEL */
  38 #include <stdbool.h>
  39 #include <stdint.h>
  40 #endif /* _KERNEL */
  41
  42 /**
  43  * BHND NVRAM boolean type; guaranteed to be exactly 8-bits, representing
  44  * true as integer constant 1, and false as integer constant 0.
  45  *
  46  * Compatible with stdbool constants (true, false).
  47  */
  48 typedef uint8_t bhnd_nvram_bool_t;
  49
  50 /**
  51  * NVRAM data sources supported by bhnd(4) devices.
  52  */
  53 typedef enum {
  54         BHND_NVRAM_SRC_OTP,     /**< On-chip one-time-programmable
  55                                   *  memory. */
  56
  57         BHND_NVRAM_SRC_FLASH,   /**< External flash */
  58         BHND_NVRAM_SRC_SPROM,   /**< External serial EEPROM. */
  59
  60         BHND_NVRAM_SRC_UNKNOWN  /**< No NVRAM source is directly
  61                                   *  attached.
  62                                   *
  63                                   *  This will be returned by ChipCommon
  64                                   *  revisions (rev <= 31) used in early
  65                                   *  chipsets that vend SPROM/OTP via the
  66                                   *  native host bridge interface.
  67                                   *
  68                                   *  For example, PCMCIA cards may vend
  69                                   *  Broadcom NVRAM data via their standard CIS
  70                                   *  table, and earlier PCI(e) devices map
  71                                   *  SPROM statically into PCI BARs, and the
  72                                   *  control registers into PCI config space.
  73
  74                                   *  This will also be returned on later
  75                                   *  devices that are attached via PCI(e) to
  76                                   *  BHND SoCs, but do not include an attached
  77                                   *  SPROM, or programmed OTP. On such SoCs,
  78                                   *  NVRAM configuration for individual devices
  79                                   *  is provided by a common platform NVRAM
  80                                   *  device.
  81                                   */
  82 } bhnd_nvram_src;
  83
  84 /**
  85  * NVRAM data types.
  86  *
  87  * @internal
  88  *
  89  * All primitive (non-array) constants should be representable as a 4-bit
  90  * integer (e.g. 0-15) to support SPROM_OPCODE_TYPE_IMM encoding as used by
  91  * nvram_map_gen.awk.
  92  */
  93 typedef enum {
  94         BHND_NVRAM_TYPE_UINT8           = 0,    /**< unsigned 8-bit integer */
  95         BHND_NVRAM_TYPE_UINT16          = 1,    /**< unsigned 16-bit integer */
  96         BHND_NVRAM_TYPE_UINT32          = 2,    /**< unsigned 32-bit integer */
  97         BHND_NVRAM_TYPE_UINT64          = 3,    /**< signed 64-bit integer */
  98         BHND_NVRAM_TYPE_INT8            = 4,    /**< signed 8-bit integer */
  99         BHND_NVRAM_TYPE_INT16           = 5,    /**< signed 16-bit integer */
 100         BHND_NVRAM_TYPE_INT32           = 6,    /**< signed 32-bit integer */
 101         BHND_NVRAM_TYPE_INT64           = 7,    /**< signed 64-bit integer */
 102         BHND_NVRAM_TYPE_CHAR            = 8,    /**< ASCII/UTF-8 character */
 103         BHND_NVRAM_TYPE_STRING          = 9,    /**< ASCII/UTF-8 NUL-terminated
 104                                                      string */
 105         BHND_NVRAM_TYPE_BOOL            = 10,   /**< uint8 boolean value. see
 106                                                      bhnd_nvram_bool_t. */
 107         BHND_NVRAM_TYPE_NULL            = 11,   /**< NULL (empty) value */
 108         BHND_NVRAM_TYPE_DATA            = 12,   /**< opaque octet string */
 109
 110         /* 10-15 reserved for primitive (non-array) types */
 111
 112         BHND_NVRAM_TYPE_UINT8_ARRAY     = 16,   /**< array of uint8 integers */
 113         BHND_NVRAM_TYPE_UINT16_ARRAY    = 17,   /**< array of uint16 integers */
 114         BHND_NVRAM_TYPE_UINT32_ARRAY    = 18,   /**< array of uint32 integers */
 115         BHND_NVRAM_TYPE_UINT64_ARRAY    = 19,   /**< array of uint64 integers */
 116         BHND_NVRAM_TYPE_INT8_ARRAY      = 20,   /**< array of int8 integers */
 117         BHND_NVRAM_TYPE_INT16_ARRAY     = 21,   /**< array of int16 integers */
 118         BHND_NVRAM_TYPE_INT32_ARRAY     = 22,   /**< array of int32 integers */
 119         BHND_NVRAM_TYPE_INT64_ARRAY     = 23,   /**< array of int64 integers */
 120         BHND_NVRAM_TYPE_CHAR_ARRAY      = 24,   /**< array of ASCII/UTF-8
 121                                                      characters */
 122         BHND_NVRAM_TYPE_STRING_ARRAY    = 25,   /**< array of ASCII/UTF-8
 123                                                      NUL-terminated strings */
 124         BHND_NVRAM_TYPE_BOOL_ARRAY      = 26,   /**< array of uint8 boolean
 125                                                      values */
 126 } bhnd_nvram_type;
 127
 128
 129 bool             bhnd_nvram_is_signed_type(bhnd_nvram_type type);
 130 bool             bhnd_nvram_is_unsigned_type(bhnd_nvram_type type);
 131 bool             bhnd_nvram_is_int_type(bhnd_nvram_type type);
 132 bool             bhnd_nvram_is_array_type(bhnd_nvram_type type);
 133 bhnd_nvram_type  bhnd_nvram_base_type(bhnd_nvram_type type);
 134 bhnd_nvram_type  bhnd_nvram_raw_type(bhnd_nvram_type type);
 135 const char      *bhnd_nvram_type_name(bhnd_nvram_type type);
 136 size_t           bhnd_nvram_type_width(bhnd_nvram_type type);
 137 size_t           bhnd_nvram_type_host_align(bhnd_nvram_type type);
 138
 139 const char      *bhnd_nvram_string_array_next(const char *inp, size_t ilen,
 140                      const char *prev, size_t *olen);
 141
 142 #endif /* _BHND_NVRAM_BHND_NVRAM_H_ */