1 /* $NetBSD: cfe_api_int.h,v 1.1 2002/11/09 06:20:40 cgd Exp $ */ 2 /* from: SiByte Id: cfe_api_int.h,v 1.21 2002/07/09 23:29:11 cgd Exp $ */ 3 4 /* 5 * Copyright 2000, 2001, 2002 6 * Broadcom Corporation. All rights reserved. 7 * 8 * This software is furnished under license and may be used and copied only 9 * in accordance with the following terms and conditions. Subject to these 10 * conditions, you may download, copy, install, use, modify and distribute 11 * modified or unmodified copies of this software in source and/or binary 12 * form. No title 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 36 /* ********************************************************************* 37 * 38 * Broadcom Common Firmware Environment (CFE) 39 * 40 * Device function prototypes File: cfe_api_int.h 41 * 42 * This header defines all internal types and macros for the 43 * library. This is stuff that's not exported to an app 44 * using the library. 45 * 46 * Authors: Mitch Lichtenberg, Chris Demetriou 47 * 48 ********************************************************************* */ 49 50 #ifndef CFE_API_INT_H 51 #define CFE_API_INT_H 52 53 /* ********************************************************************* 54 * Constants 55 ********************************************************************* */ 56 57 #define CFE_CMD_FW_GETINFO 0 58 #define CFE_CMD_FW_RESTART 1 59 #define CFE_CMD_FW_BOOT 2 60 #define CFE_CMD_FW_CPUCTL 3 61 #define CFE_CMD_FW_GETTIME 4 62 #define CFE_CMD_FW_MEMENUM 5 63 #define CFE_CMD_FW_FLUSHCACHE 6 64 65 #define CFE_CMD_DEV_GETHANDLE 9 66 #define CFE_CMD_DEV_ENUM 10 67 #define CFE_CMD_DEV_OPEN 11 68 #define CFE_CMD_DEV_INPSTAT 12 69 #define CFE_CMD_DEV_READ 13 70 #define CFE_CMD_DEV_WRITE 14 71 #define CFE_CMD_DEV_IOCTL 15 72 #define CFE_CMD_DEV_CLOSE 16 73 #define CFE_CMD_DEV_GETINFO 17 74 75 #define CFE_CMD_ENV_ENUM 20 76 #define CFE_CMD_ENV_GET 22 77 #define CFE_CMD_ENV_SET 23 78 #define CFE_CMD_ENV_DEL 24 79 80 #define CFE_CMD_MAX 32 81 82 #define CFE_CMD_VENDOR_USE 0x8000 /* codes above this are for customer use */ 83 84 /* ********************************************************************* 85 * Structures 86 ********************************************************************* */ 87 88 typedef uint64_t cfe_xuint_t; 89 typedef int64_t cfe_xint_t; 90 typedef int64_t cfe_xptr_t; 91 92 typedef struct xiocb_buffer_s { 93 cfe_xuint_t buf_offset; /* offset on device (bytes) */ 94 cfe_xptr_t buf_ptr; /* pointer to a buffer */ 95 cfe_xuint_t buf_length; /* length of this buffer */ 96 cfe_xuint_t buf_retlen; /* returned length (for read ops) */ 97 cfe_xuint_t buf_ioctlcmd; /* IOCTL command (used only for IOCTLs) */ 98 } xiocb_buffer_t; 99 100 #define buf_devflags buf_ioctlcmd /* returned device info flags */ 101 102 typedef struct xiocb_inpstat_s { 103 cfe_xuint_t inp_status; /* 1 means input available */ 104 } xiocb_inpstat_t; 105 106 typedef struct xiocb_envbuf_s { 107 cfe_xint_t enum_idx; /* 0-based enumeration index */ 108 cfe_xptr_t name_ptr; /* name string buffer */ 109 cfe_xint_t name_length; /* size of name buffer */ 110 cfe_xptr_t val_ptr; /* value string buffer */ 111 cfe_xint_t val_length; /* size of value string buffer */ 112 } xiocb_envbuf_t; 113 114 typedef struct xiocb_cpuctl_s { 115 cfe_xuint_t cpu_number; /* cpu number to control */ 116 cfe_xuint_t cpu_command; /* command to issue to CPU */ 117 cfe_xuint_t start_addr; /* CPU start address */ 118 cfe_xuint_t gp_val; /* starting GP value */ 119 cfe_xuint_t sp_val; /* starting SP value */ 120 cfe_xuint_t a1_val; /* starting A1 value */ 121 } xiocb_cpuctl_t; 122 123 typedef struct xiocb_time_s { 124 cfe_xint_t ticks; /* current time in ticks */ 125 } xiocb_time_t; 126 127 typedef struct xiocb_exitstat_s { 128 cfe_xint_t status; 129 } xiocb_exitstat_t; 130 131 typedef struct xiocb_meminfo_s { 132 cfe_xint_t mi_idx; /* 0-based enumeration index */ 133 cfe_xint_t mi_type; /* type of memory block */ 134 cfe_xuint_t mi_addr; /* physical start address */ 135 cfe_xuint_t mi_size; /* block size */ 136 } xiocb_meminfo_t; 137 138 typedef struct xiocb_fwinfo_s { 139 cfe_xint_t fwi_version; /* major, minor, eco version */ 140 cfe_xint_t fwi_totalmem; /* total installed mem */ 141 cfe_xint_t fwi_flags; /* various flags */ 142 cfe_xint_t fwi_boardid; /* board ID */ 143 cfe_xint_t fwi_bootarea_va; /* VA of boot area */ 144 cfe_xint_t fwi_bootarea_pa; /* PA of boot area */ 145 cfe_xint_t fwi_bootarea_size; /* size of boot area */ 146 cfe_xint_t fwi_reserved1; 147 cfe_xint_t fwi_reserved2; 148 cfe_xint_t fwi_reserved3; 149 } xiocb_fwinfo_t; 150 151 typedef struct cfe_xiocb_s { 152 cfe_xuint_t xiocb_fcode; /* IOCB function code */ 153 cfe_xint_t xiocb_status; /* return status */ 154 cfe_xint_t xiocb_handle; /* file/device handle */ 155 cfe_xuint_t xiocb_flags; /* flags for this IOCB */ 156 cfe_xuint_t xiocb_psize; /* size of parameter list */ 157 union { 158 xiocb_buffer_t xiocb_buffer; /* buffer parameters */ 159 xiocb_inpstat_t xiocb_inpstat; /* input status parameters */ 160 xiocb_envbuf_t xiocb_envbuf; /* environment function parameters */ 161 xiocb_cpuctl_t xiocb_cpuctl; /* CPU control parameters */ 162 xiocb_time_t xiocb_time; /* timer parameters */ 163 xiocb_meminfo_t xiocb_meminfo; /* memory arena info parameters */ 164 xiocb_fwinfo_t xiocb_fwinfo; /* firmware information */ 165 xiocb_exitstat_t xiocb_exitstat; /* Exit Status */ 166 } plist; 167 } cfe_xiocb_t; 168 169 #endif /* CFE_API_INT_H */ 170