sys/dev/bhnd/nvram/bhnd_nvram_data_bcmreg.h

   1 /*-
   2  * Copyright (c) 2015-2016 Landon Fuller <landonf@FreeBSD.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_BCMREG_H_
  33 #define _BHND_NVRAM_BHND_NVRAM_BCMREG_H_
  34
  35 #define BCM_NVRAM_GET_BITS(_value, _field)                      \
  36         ((_value & _field ## _MASK) >> _field ## _SHIFT)
  37
  38 #define BCM_NVRAM_SET_BITS(_value, _field, _bits)               \
  39         ((_value & ~(_field ## _MASK)) |                        \
  40             (((_bits) << _field ## _SHIFT) & _field ## _MASK))
  41
  42 /* BCM NVRAM header fields */
  43 #define BCM_NVRAM_MAGIC                         0x48534C46      /* 'FLSH' */
  44 #define BCM_NVRAM_VERSION                       1
  45
  46 #define BCM_NVRAM_CRC_SKIP                      9               /* skip magic, size, and crc8 */
  47
  48 #define BCM_NVRAM_CFG0_CRC_MASK                 0x000000FF
  49 #define BCM_NVRAM_CFG0_CRC_SHIFT                0
  50 #define BCM_NVRAM_CFG0_VER_MASK                 0x0000FF00
  51 #define BCM_NVRAM_CFG0_VER_SHIFT                8
  52 #define BCM_NVRAM_CFG0_VER_DEFAULT              1               /* default version */
  53
  54 #define BCM_NVRAM_CFG0_SDRAM_INIT_FIELD         cfg0
  55 #define BCM_NVRAM_CFG0_SDRAM_INIT_MASK          0xFFFF0000
  56 #define BCM_NVRAM_CFG0_SDRAM_INIT_SHIFT         16
  57 #define BCM_NVRAM_CFG0_SDRAM_INIT_VAR           "sdram_init"
  58 #define BCM_NVRAM_CFG0_SDRAM_INIT_FMT           "0x%04x"
  59
  60 #define BCM_NVRAM_CFG1_SDRAM_CFG_FIELD          cfg1
  61 #define BCM_NVRAM_CFG1_SDRAM_CFG_MASK           0x0000FFFF
  62 #define BCM_NVRAM_CFG1_SDRAM_CFG_SHIFT          0
  63 #define BCM_NVRAM_CFG1_SDRAM_CFG_VAR            "sdram_config"
  64 #define BCM_NVRAM_CFG1_SDRAM_CFG_FMT            "0x%04x"
  65
  66 #define BCM_NVRAM_CFG1_SDRAM_REFRESH_FIELD      cfg1
  67 #define BCM_NVRAM_CFG1_SDRAM_REFRESH_MASK       0xFFFF0000
  68 #define BCM_NVRAM_CFG1_SDRAM_REFRESH_SHIFT      16
  69 #define BCM_NVRAM_CFG1_SDRAM_REFRESH_VAR        "sdram_refresh"
  70 #define BCM_NVRAM_CFG1_SDRAM_REFRESH_FMT        "0x%04x"
  71
  72 #define BCM_NVRAM_SDRAM_NCDL_FIELD              sdram_ncdl
  73 #define BCM_NVRAM_SDRAM_NCDL_MASK               UINT32_MAX
  74 #define BCM_NVRAM_SDRAM_NCDL_SHIFT              0
  75 #define BCM_NVRAM_SDRAM_NCDL_VAR                "sdram_ncdl"
  76 #define BCM_NVRAM_SDRAM_NCDL_FMT                "0x%08x"
  77
  78 #endif /* _BHND_NVRAM_BHND_NVRAM_BCMREG_H_ */