sys/dev/nvram2env/nvram2env.h

   1 /*-
   2  * Copyright (c) 2010 Aleksandr Rybalko.
   3  * Copyright (c) 2016 Michael Zhilin.
   4  * All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions
   8  * are met:
   9  * 1. Redistributions of source code must retain the above copyright
  10  *    notice, this list of conditions and the following disclaimer.
  11  * 2. Redistributions in binary form must reproduce the above copyright
  12  *    notice, this list of conditions and the following disclaimer in the
  13  *    documentation and/or other materials provided with the distribution.
  14  *
  15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  16  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  18  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  19  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  20  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  21  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  22  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  23  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  24  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  25  * SUCH DAMAGE.
  26  *
  27  * $FreeBSD$
  28  */
  29
  30 #ifndef NVRAM2ENV_NVRAM2ENV_H_
  31 #define NVRAM2ENV_NVRAM2ENV_H_
  32
  33 #define nvram2env_read_1(sc, reg)                               \
  34         bus_space_read_1((sc)->sc_bt, (sc)->sc_bh,(reg))
  35
  36 #define nvram2env_read_2(sc, reg)                               \
  37         bus_space_read_2((sc)->sc_bt, (sc)->sc_bh,(reg))
  38
  39 #define nvram2env_read_4(sc, reg)                               \
  40         bus_space_read_4((sc)->sc_bt, (sc)->sc_bh,(reg))
  41
  42 #define nvram2env_write_1(sc, reg, val)                 \
  43         bus_space_write_1((sc)->sc_bt, (sc)->sc_bh,     \
  44                          (reg), (val))
  45
  46 #define nvram2env_write_2(sc, reg, val)                 \
  47         bus_space_write_2((sc)->sc_bt, (sc)->sc_bh,     \
  48                          (reg), (val))
  49
  50 #define nvram2env_write_4(sc, reg, val)                 \
  51         bus_space_write_4((sc)->sc_bt, (sc)->sc_bh,     \
  52                          (reg), (val))
  53
  54 struct nvram2env_softc {
  55         bus_space_tag_t bst;
  56         bus_space_handle_t bsh;
  57         bus_addr_t addr;
  58         int need_swap;
  59         uint32_t sig;
  60         uint32_t flags;
  61 #define NVRAM_FLAGS_NOCHECK     0x0001  /* Do not check(CRC or somthing else)*/
  62 #define NVRAM_FLAGS_GENERIC     0x0002  /* Format Generic, skip 4b and read */
  63 #define NVRAM_FLAGS_BROADCOM    0x0004  /* Format Broadcom, use struct nvram */
  64 #define NVRAM_FLAGS_UBOOT       0x0008  /* Format Generic, skip 4b of CRC and read */
  65         uint32_t maxsize;
  66         uint32_t crc;
  67 };
  68
  69 #define NVRAM_MAX_SIZE  0x10000
  70 #define CFE_NVRAM_SIGNATURE 0x48534c46
  71
  72 struct nvram {
  73         u_int32_t sig;
  74         u_int32_t size;
  75         u_int32_t unknown1;
  76         u_int32_t unknown2;
  77         u_int32_t unknown3;
  78         char data[];
  79 };
  80
  81 int             nvram2env_attach(device_t);
  82 int             nvram2env_probe(device_t);
  83
  84 extern devclass_t       nvram2env_devclass;
  85 extern driver_t         nvram2env_driver;
  86
  87 #endif /* SYS_DEV_NVRAM2ENV_NVRAM2ENV_H_ */