release/src-rt-6.x.4708/cfe/cfe/include/cfe_iocb.h

   1 /*  *********************************************************************
   2     *  Broadcom Common Firmware Environment (CFE)
   3     *
   4     *  IOCB definitions                         File: cfe_iocb.h
   5     *
   6     *  This module describes CFE's IOCB structure, the main
   7     *  data structure used to communicate API requests with CFE.
   8     *
   9     *  Author:  Mitch Lichtenberg (mpl@broadcom.com)
  10     *
  11     *********************************************************************
  12     *
  13     *  Copyright 2000,2001,2002,2003
  14     *  Broadcom Corporation. All rights reserved.
  15     *
  16     *  This software is furnished under license and may be used and
  17     *  copied only in accordance with the following terms and
  18     *  conditions.  Subject to these conditions, you may download,
  19     *  copy, install, use, modify and distribute modified or unmodified
  20     *  copies of this software in source and/or binary form.  No title
  21     *  or ownership is transferred hereby.
  22     *
  23     *  1) Any source code used, modified or distributed must reproduce
  24     *     and retain this copyright notice and list of conditions
  25     *     as they appear in the source file.
  26     *
  27     *  2) No right is granted to use any trade name, trademark, or
  28     *     logo of Broadcom Corporation.  The "Broadcom Corporation"
  29     *     name may not be used to endorse or promote products derived
  30     *     from this software without the prior written permission of
  31     *     Broadcom Corporation.
  32     *
  33     *  3) THIS SOFTWARE IS PROVIDED "AS-IS" AND ANY EXPRESS OR
  34     *     IMPLIED WARRANTIES, INCLUDING BUT NOT LIMITED TO, ANY IMPLIED
  35     *     WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
  36     *     PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED. IN NO EVENT
  37     *     SHALL BROADCOM BE LIABLE FOR ANY DAMAGES WHATSOEVER, AND IN
  38     *     PARTICULAR, BROADCOM SHALL NOT BE LIABLE FOR DIRECT, INDIRECT,
  39     *     INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  40     *     (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
  41     *     GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
  42     *     BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
  43     *     OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
  44     *     TORT (INCLUDING NEGLIGENCE OR OTHERWISE), EVEN IF ADVISED OF
  45     *     THE POSSIBILITY OF SUCH DAMAGE.
  46     ********************************************************************* */
  47
  48 #ifndef _CFE_IOCB_H
  49 #define _CFE_IOCB_H
  50
  51 /*  *********************************************************************
  52     *  Constants
  53     ********************************************************************* */
  54
  55 #define CFE_CMD_FW_GETINFO      0
  56 #define CFE_CMD_FW_RESTART      1
  57 #define CFE_CMD_FW_BOOT         2
  58 #define CFE_CMD_FW_CPUCTL       3
  59 #define CFE_CMD_FW_GETTIME      4
  60 #define CFE_CMD_FW_MEMENUM      5
  61 #define CFE_CMD_FW_FLUSHCACHE   6
  62
  63 #define CFE_CMD_DEV_GETHANDLE   9
  64 #define CFE_CMD_DEV_ENUM        10
  65 #define CFE_CMD_DEV_OPEN        11
  66 #define CFE_CMD_DEV_INPSTAT     12
  67 #define CFE_CMD_DEV_READ        13
  68 #define CFE_CMD_DEV_WRITE       14
  69 #define CFE_CMD_DEV_IOCTL       15
  70 #define CFE_CMD_DEV_CLOSE       16
  71 #define CFE_CMD_DEV_GETINFO     17
  72
  73 #define CFE_CMD_ENV_ENUM        20
  74 #define CFE_CMD_ENV_GET         22
  75 #define CFE_CMD_ENV_SET         23
  76 #define CFE_CMD_ENV_DEL         24
  77
  78 #define CFE_CMD_MAX             32
  79
  80 #define CFE_CMD_VENDOR_USE      0x8000  /* codes above this are for customer use */
  81
  82 #define CFE_MI_RESERVED 0               /* memory is reserved, do not use */
  83 #define CFE_MI_AVAILABLE 1              /* memory is available */
  84
  85 #define CFE_FLG_WARMSTART     0x00000001
  86 #define CFE_FLG_FULL_ARENA    0x00000001
  87 #define CFE_FLG_ENV_PERMANENT 0x00000001
  88
  89 #define CFE_CPU_CMD_START 1
  90 #define CFE_CPU_CMD_STOP 0
  91
  92 #define CFE_STDHANDLE_CONSOLE   0
  93
  94 #define CFE_DEV_NETWORK         1
  95 #define CFE_DEV_DISK            2
  96 #define CFE_DEV_FLASH           3
  97 #define CFE_DEV_SERIAL          4
  98 #define CFE_DEV_CPU             5
  99 #define CFE_DEV_NVRAM           6
 100 #define CFE_DEV_CLOCK           7
 101 #define CFE_DEV_OTHER           8
 102 #define CFE_DEV_MASK            0x0F
 103
 104 #define CFE_CACHE_FLUSH_D       1
 105 #define CFE_CACHE_INVAL_I       2
 106 #define CFE_CACHE_INVAL_D       4
 107 #define CFE_CACHE_INVAL_L2      8
 108 #define CFE_CACHE_FLUSH_L2      16
 109 #define CFE_CACHE_INVAL_RANGE   32
 110 #define CFE_CACHE_FLUSH_RANGE   64
 111
 112 #ifndef __ASSEMBLER__
 113
 114 /*  *********************************************************************
 115     *  Structures
 116     ********************************************************************* */
 117
 118 #define unsigned signed         /* Kludge to get unsigned size-shaped type. */
 119 typedef __SIZE_TYPE__ cfe_int_t;
 120 #undef unsigned
 121 typedef __SIZE_TYPE__ cfe_uint_t;
 122 typedef unsigned long long cfe_offset_t;
 123 typedef long long cfe_int64_t;
 124 typedef unsigned char *cfe_ptr_t;
 125
 126 typedef struct iocb_buffer_s {
 127     cfe_offset_t  buf_offset;           /* offset on device (bytes) */
 128     cfe_ptr_t buf_ptr;                  /* pointer to a buffer */
 129     cfe_uint_t   buf_length;            /* length of this buffer */
 130     cfe_uint_t   buf_retlen;            /* returned length (for read ops) */
 131     cfe_uint_t   buf_ioctlcmd;          /* IOCTL command (used only for IOCTLs) */
 132 } iocb_buffer_t;
 133
 134 #define buf_devflags buf_ioctlcmd       /* returned device info flags */
 135
 136 typedef struct iocb_inpstat_s {
 137     cfe_uint_t inp_status;              /* 1 means input available */
 138 } iocb_inpstat_t;
 139
 140 typedef struct iocb_envbuf_s {
 141     int enum_idx;                       /* 0-based enumeration index */
 142     cfe_ptr_t name_ptr;                 /* name string buffer */
 143     cfe_int_t name_length;              /* size of name buffer */
 144     cfe_ptr_t val_ptr;                  /* value string buffer */
 145     cfe_int_t val_length;               /* size of value string buffer */
 146 } iocb_envbuf_t;
 147
 148 typedef struct iocb_cpuctl_s {
 149     cfe_uint_t  cpu_number;             /* cpu number to control */
 150     cfe_uint_t  cpu_command;            /* command to issue to CPU */
 151     cfe_uint_t  start_addr;             /* CPU start address */
 152     cfe_uint_t  gp_val;                 /* starting GP value */
 153     cfe_uint_t  sp_val;                 /* starting SP value */
 154     cfe_uint_t  a1_val;                 /* starting A1 value */
 155 } iocb_cpuctl_t;
 156
 157 typedef struct iocb_time_s {
 158     long long ticks;                    /* current time in ticks */
 159 } iocb_time_t;
 160
 161 typedef struct iocb_exitstat_s {
 162     cfe_int_t status;
 163 } iocb_exitstat_t;
 164
 165 typedef struct iocb_meminfo_s {
 166     cfe_int_t mi_idx;                   /* 0-based enumeration index */
 167     cfe_int_t mi_type;                  /* type of memory block */
 168     cfe_int64_t mi_addr;                /* physical start address */
 169     cfe_int64_t mi_size;                /* block size */
 170 } iocb_meminfo_t;
 171
 172 #define CFE_FWI_64BIT           0x00000001
 173 #define CFE_FWI_32BIT           0x00000002
 174 #define CFE_FWI_RELOC           0x00000004
 175 #define CFE_FWI_UNCACHED        0x00000008
 176 #define CFE_FWI_MULTICPU        0x00000010
 177 #define CFE_FWI_FUNCSIM         0x00000020
 178 #define CFE_FWI_RTLSIM          0x00000040
 179
 180 typedef struct iocb_fwinfo_s {
 181     cfe_int64_t fwi_version;            /* major, minor, eco version */
 182     cfe_int64_t fwi_totalmem;           /* total installed mem */
 183     cfe_int64_t fwi_flags;              /* various flags */
 184     cfe_int64_t fwi_boardid;            /* board ID */
 185     cfe_int64_t fwi_bootarea_va;        /* VA of boot area */
 186     cfe_int64_t fwi_bootarea_pa;        /* PA of boot area */
 187     cfe_int64_t fwi_bootarea_size;      /* size of boot area */
 188     cfe_int64_t fwi_reserved1;
 189     cfe_int64_t fwi_reserved2;
 190     cfe_int64_t fwi_reserved3;
 191 } iocb_fwinfo_t;
 192
 193
 194 typedef struct cfe_iocb_s {
 195     cfe_uint_t iocb_fcode;              /* IOCB function code */
 196     cfe_int_t iocb_status;              /* return status */
 197     cfe_int_t iocb_handle;              /* file/device handle */
 198     cfe_uint_t iocb_flags;              /* flags for this IOCB */
 199     cfe_uint_t iocb_psize;              /* size of parameter list */
 200     union {
 201         iocb_buffer_t iocb_buffer;      /* buffer parameters */
 202         iocb_inpstat_t iocb_inpstat;    /* input status parameters */
 203         iocb_envbuf_t iocb_envbuf;      /* environment function parameters */
 204         iocb_cpuctl_t iocb_cpuctl;      /* CPU control parameters */
 205         iocb_time_t   iocb_time;        /* timer parameters */
 206         iocb_meminfo_t iocb_meminfo;    /* memory arena info parameters */
 207         iocb_fwinfo_t iocb_fwinfo;      /* firmware information */
 208         iocb_exitstat_t iocb_exitstat;  /* Exit Status */
 209     } plist;
 210 } cfe_iocb_t;
 211
 212 #endif
 213
 214 #endif