sys/dev/cfe/cfe_ioctl.h

   1 /*-
   2  * SPDX-License-Identifier: BSD-3-Clause
   3  *
   4  * Copyright 2000, 2001, 2002, 2003
   5  * Broadcom Corporation. All rights reserved.
   6  *
   7  * This software is furnished under license and may be used and
   8  * copied only in accordance with the following terms and
   9  * conditions.  Subject to these conditions, you may download,
  10  * copy, install, use, modify and distribute modified or unmodified
  11  * copies of this software in source and/or binary form.  No title
  12  * or ownership is transferred hereby.
  13  *
  14  * 1) Any source code used, modified or distributed must reproduce and
  15  *    retain this copyright notice and list of conditions as they appear in
  16  *    the source file.
  17  *
  18  * 2) No right is granted to use any trade name, trademark, or logo of
  19  *    Broadcom Corporation.  The "Broadcom Corporation" name may not be
  20  *    used to endorse or promote products derived from this software
  21  *    without the prior written permission of Broadcom Corporation.
  22  *
  23  * 3) THIS SOFTWARE IS PROVIDED "AS-IS" AND ANY EXPRESS OR IMPLIED
  24  *    WARRANTIES, INCLUDING BUT NOT LIMITED TO, ANY IMPLIED WARRANTIES OF
  25  *    MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR
  26  *    NON-INFRINGEMENT ARE DISCLAIMED. IN NO EVENT SHALL BROADCOM BE LIABLE
  27  *    FOR ANY DAMAGES WHATSOEVER, AND IN PARTICULAR, BROADCOM SHALL NOT BE
  28  *    LIABLE FOR DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  29  *    CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  30  *    SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
  31  *    BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  32  *    WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
  33  *    OR OTHERWISE), EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  34  *
  35  * $FreeBSD$
  36  */
  37
  38 /*  *********************************************************************
  39     *  Broadcom Common Firmware Environment (CFE)
  40     *
  41     *  IOCTL definitions                        File: cfe_ioctl.h
  42     *
  43     *  IOCTL function numbers and I/O data structures.
  44     *
  45     *  Author:  Mitch Lichtenberg
  46     *
  47     ********************************************************************* */
  48
  49 /*  *********************************************************************
  50     *  NVFAM and FLASH stuff
  51     ********************************************************************* */
  52
  53 #define IOCTL_NVRAM_GETINFO     1       /* return nvram_info_t */
  54 #define IOCTL_NVRAM_ERASE       2       /* erase sector containing nvram_info_t area */
  55 #define IOCTL_FLASH_ERASE_SECTOR 3      /* erase an arbitrary sector */
  56 #define IOCTL_FLASH_ERASE_ALL   4       /* Erase the entire flash */
  57 #define IOCTL_FLASH_WRITE_ALL   5       /* write entire flash */
  58 #define IOCTL_FLASH_GETINFO     6       /* get flash device info */
  59 #define IOCTL_FLASH_GETSECTORS  7       /* get sector information */
  60 #define IOCTL_FLASH_ERASE_RANGE 8       /* erase range of bytes */
  61 #define IOCTL_NVRAM_UNLOCK      9       /* allow r/w beyond logical end of device */
  62 #define IOCTL_FLASH_PROTECT_RANGE 10    /* Protect a group of sectors */
  63 #define IOCTL_FLASH_UNPROTECT_RANGE 11  /* unprotect a group of sectors */
  64 #define IOCTL_FLASH_DATA_WIDTH_MODE     12      /* switch flash and gen bus to support 8 or 16-bit mode I/Os */
  65 #define IOCTL_FLASH_BURST_MODE  13      /* configure gen bus for burst mode */
  66
  67 typedef struct flash_range_s {
  68     unsigned int range_base;
  69     unsigned int range_length;
  70 } flash_range_t;
  71
  72 typedef struct flash_info_s {
  73     unsigned long long flash_base;      /* flash physical base address */
  74     unsigned int flash_size;            /* available device size in bytes */
  75     unsigned int flash_type;            /* type, from FLASH_TYPE below */
  76     unsigned int flash_flags;           /* Various flags (FLASH_FLAG_xxx) */
  77 } flash_info_t;
  78
  79 typedef struct flash_sector_s {
  80     int flash_sector_idx;
  81     int flash_sector_status;
  82     unsigned int flash_sector_offset;
  83     unsigned int flash_sector_size;
  84 } flash_sector_t;
  85
  86 #define FLASH_SECTOR_OK         0
  87 #define FLASH_SECTOR_INVALID    -1
  88
  89 #define FLASH_TYPE_UNKNOWN      0       /* not sure what kind of flash */
  90 #define FLASH_TYPE_SRAM         1       /* not flash: it's SRAM */
  91 #define FLASH_TYPE_ROM          2       /* not flash: it's ROM */
  92 #define FLASH_TYPE_FLASH        3       /* it's flash memory of some sort */
  93
  94 #define FLASH_FLAG_NOERASE      1       /* Byte-range writes supported,
  95                                            Erasing is not necessary */
  96
  97 typedef struct nvram_info_s {
  98     int nvram_offset;                   /* offset of environment area */
  99     int nvram_size;                     /* size of environment area */
 100     int nvram_eraseflg;                 /* true if we need to erase first */
 101 } nvram_info_t;
 102
 103 /*  *********************************************************************
 104     *  Ethernet stuff
 105     ********************************************************************* */
 106
 107 #define IOCTL_ETHER_GETHWADDR   1       /* Get hardware address (6bytes) */
 108 #define IOCTL_ETHER_SETHWADDR   2       /* Set hardware address (6bytes) */
 109 #define IOCTL_ETHER_GETSPEED    3       /* Get Speed and Media (int) */
 110 #define IOCTL_ETHER_SETSPEED    4       /* Set Speed and Media (int) */
 111 #define IOCTL_ETHER_GETLINK     5       /* get link status (int) */
 112 #define IOCTL_ETHER_GETLOOPBACK 7       /* get loopback state */
 113 #define IOCTL_ETHER_SETLOOPBACK 8       /* set loopback state */
 114 #define IOCTL_ETHER_SETPACKETFIFO 9     /* set packet fifo mode (int) */
 115 #define IOCTL_ETHER_SETSTROBESIG 10     /* set strobe signal (int) */
 116
 117 #define ETHER_LOOPBACK_OFF      0       /* no loopback */
 118 #define ETHER_LOOPBACK_INT      1       /* Internal loopback */
 119 #define ETHER_LOOPBACK_EXT      2       /* External loopback (through PHY) */
 120
 121 #define ETHER_SPEED_AUTO        0       /* Auto detect */
 122 #define ETHER_SPEED_UNKNOWN     0       /* Speed not known (on link status) */
 123 #define ETHER_SPEED_10HDX       1       /* 10MB hdx and fdx */
 124 #define ETHER_SPEED_10FDX       2
 125 #define ETHER_SPEED_100HDX      3       /* 100MB hdx and fdx */
 126 #define ETHER_SPEED_100FDX      4
 127 #define ETHER_SPEED_1000HDX     5       /* 1000MB hdx and fdx */
 128 #define ETHER_SPEED_1000FDX     6
 129
 130 #define ETHER_FIFO_8            0       /* 8-bit packet fifo mode */
 131 #define ETHER_FIFO_16           1       /* 16-bit packet fifo mode */
 132 #define ETHER_ETHER             2       /* Standard ethernet mode */
 133
 134 #define ETHER_STROBE_GMII       0       /* GMII style strobe signal */
 135 #define ETHER_STROBE_ENCODED    1       /* Encoded */
 136 #define ETHER_STROBE_SOP        2       /* SOP flagged. Only in 8-bit mode*/
 137 #define ETHER_STROBE_EOP        3       /* EOP flagged. Only in 8-bit mode*/
 138
 139 /*  *********************************************************************
 140     *  Serial Ports
 141     ********************************************************************* */
 142
 143 #define IOCTL_SERIAL_SETSPEED   1       /* get baud rate (int) */
 144 #define IOCTL_SERIAL_GETSPEED   2       /* set baud rate (int) */
 145 #define IOCTL_SERIAL_SETFLOW    3       /* Set Flow Control */
 146 #define IOCTL_SERIAL_GETFLOW    4       /* Get Flow Control */
 147
 148 #define SERIAL_FLOW_NONE        0       /* no flow control */
 149 #define SERIAL_FLOW_SOFTWARE    1       /* software flow control (not impl) */
 150 #define SERIAL_FLOW_HARDWARE    2       /* hardware flow control */
 151
 152 /*  *********************************************************************
 153     *  Block device stuff
 154     ********************************************************************* */
 155
 156 #define IOCTL_BLOCK_GETBLOCKSIZE 1      /* get block size (int) */
 157 #define IOCTL_BLOCK_GETTOTALBLOCKS 2    /* get total bocks (long long) */
 158 #define IOCTL_BLOCK_GETDEVTYPE 3        /* get device type (struct) */
 159
 160 typedef struct blockdev_info_s {
 161     unsigned long long blkdev_totalblocks;
 162     unsigned int blkdev_blocksize;
 163     unsigned int blkdev_devtype;
 164 } blockdev_info_t;
 165
 166 #define BLOCK_DEVTYPE_DISK      0
 167 #define BLOCK_DEVTYPE_CDROM     1