1 /* from: Broadcom Id: cfe_api_int.h,v 1.22 2003/02/07 17:27:56 cgd Exp $ */
4 * SPDX-License-Identifier: BSD-3-Clause
6 * Copyright 2000, 2001, 2002
7 * Broadcom Corporation. All rights reserved.
9 * This software is furnished under license and may be used and copied only
10 * in accordance with the following terms and conditions. Subject to these
11 * conditions, you may download, copy, install, use, modify and distribute
12 * modified or unmodified copies of this software in source and/or binary
13 * form. No title or ownership is transferred hereby.
15 * 1) Any source code used, modified or distributed must reproduce and
16 * retain this copyright notice and list of conditions as they appear in
19 * 2) No right is granted to use any trade name, trademark, or logo of
20 * Broadcom Corporation. The "Broadcom Corporation" name may not be
21 * used to endorse or promote products derived from this software
22 * without the prior written permission of Broadcom Corporation.
24 * 3) THIS SOFTWARE IS PROVIDED "AS-IS" AND ANY EXPRESS OR IMPLIED
25 * WARRANTIES, INCLUDING BUT NOT LIMITED TO, ANY IMPLIED WARRANTIES OF
26 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR
27 * NON-INFRINGEMENT ARE DISCLAIMED. IN NO EVENT SHALL BROADCOM BE LIABLE
28 * FOR ANY DAMAGES WHATSOEVER, AND IN PARTICULAR, BROADCOM SHALL NOT BE
29 * LIABLE FOR DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
30 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
31 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
32 * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
33 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
34 * OR OTHERWISE), EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
39 /* *********************************************************************
41 * Broadcom Common Firmware Environment (CFE)
43 * Device function prototypes File: cfe_api_int.h
45 * This header defines all internal types and macros for the
46 * library. This is stuff that's not exported to an app
49 * Authors: Mitch Lichtenberg, Chris Demetriou
51 ********************************************************************* */
56 /* *********************************************************************
58 ********************************************************************* */
60 #define CFE_CMD_FW_GETINFO 0
61 #define CFE_CMD_FW_RESTART 1
62 #define CFE_CMD_FW_BOOT 2
63 #define CFE_CMD_FW_CPUCTL 3
64 #define CFE_CMD_FW_GETTIME 4
65 #define CFE_CMD_FW_MEMENUM 5
66 #define CFE_CMD_FW_FLUSHCACHE 6
68 #define CFE_CMD_DEV_GETHANDLE 9
69 #define CFE_CMD_DEV_ENUM 10
70 #define CFE_CMD_DEV_OPEN 11
71 #define CFE_CMD_DEV_INPSTAT 12
72 #define CFE_CMD_DEV_READ 13
73 #define CFE_CMD_DEV_WRITE 14
74 #define CFE_CMD_DEV_IOCTL 15
75 #define CFE_CMD_DEV_CLOSE 16
76 #define CFE_CMD_DEV_GETINFO 17
78 #define CFE_CMD_ENV_ENUM 20
79 #define CFE_CMD_ENV_GET 22
80 #define CFE_CMD_ENV_SET 23
81 #define CFE_CMD_ENV_DEL 24
83 #define CFE_CMD_MAX 32
85 #define CFE_CMD_VENDOR_USE 0x8000 /* codes above this are for customer use */
87 /* *********************************************************************
89 ********************************************************************* */
91 typedef uint64_t cfe_xuint_t;
92 typedef int64_t cfe_xint_t;
93 typedef int64_t cfe_xptr_t;
95 typedef struct xiocb_buffer_s {
96 cfe_xuint_t buf_offset; /* offset on device (bytes) */
97 cfe_xptr_t buf_ptr; /* pointer to a buffer */
98 cfe_xuint_t buf_length; /* length of this buffer */
99 cfe_xuint_t buf_retlen; /* returned length (for read ops) */
100 cfe_xuint_t buf_ioctlcmd; /* IOCTL command (used only for IOCTLs) */
103 #define buf_devflags buf_ioctlcmd /* returned device info flags */
105 typedef struct xiocb_inpstat_s {
106 cfe_xuint_t inp_status; /* 1 means input available */
109 typedef struct xiocb_envbuf_s {
110 cfe_xint_t enum_idx; /* 0-based enumeration index */
111 cfe_xptr_t name_ptr; /* name string buffer */
112 cfe_xint_t name_length; /* size of name buffer */
113 cfe_xptr_t val_ptr; /* value string buffer */
114 cfe_xint_t val_length; /* size of value string buffer */
117 typedef struct xiocb_cpuctl_s {
118 cfe_xuint_t cpu_number; /* cpu number to control */
119 cfe_xuint_t cpu_command; /* command to issue to CPU */
120 cfe_xuint_t start_addr; /* CPU start address */
121 cfe_xuint_t gp_val; /* starting GP value */
122 cfe_xuint_t sp_val; /* starting SP value */
123 cfe_xuint_t a1_val; /* starting A1 value */
126 typedef struct xiocb_time_s {
127 cfe_xint_t ticks; /* current time in ticks */
130 typedef struct xiocb_exitstat_s {
134 typedef struct xiocb_meminfo_s {
135 cfe_xint_t mi_idx; /* 0-based enumeration index */
136 cfe_xint_t mi_type; /* type of memory block */
137 cfe_xuint_t mi_addr; /* physical start address */
138 cfe_xuint_t mi_size; /* block size */
141 typedef struct xiocb_fwinfo_s {
142 cfe_xint_t fwi_version; /* major, minor, eco version */
143 cfe_xint_t fwi_totalmem; /* total installed mem */
144 cfe_xint_t fwi_flags; /* various flags */
145 cfe_xint_t fwi_boardid; /* board ID */
146 cfe_xint_t fwi_bootarea_va; /* VA of boot area */
147 cfe_xint_t fwi_bootarea_pa; /* PA of boot area */
148 cfe_xint_t fwi_bootarea_size; /* size of boot area */
149 cfe_xint_t fwi_reserved1;
150 cfe_xint_t fwi_reserved2;
151 cfe_xint_t fwi_reserved3;
154 typedef struct cfe_xiocb_s {
155 cfe_xuint_t xiocb_fcode; /* IOCB function code */
156 cfe_xint_t xiocb_status; /* return status */
157 cfe_xint_t xiocb_handle; /* file/device handle */
158 cfe_xuint_t xiocb_flags; /* flags for this IOCB */
159 cfe_xuint_t xiocb_psize; /* size of parameter list */
161 xiocb_buffer_t xiocb_buffer; /* buffer parameters */
162 xiocb_inpstat_t xiocb_inpstat; /* input status parameters */
163 xiocb_envbuf_t xiocb_envbuf; /* environment function parameters */
164 xiocb_cpuctl_t xiocb_cpuctl; /* CPU control parameters */
165 xiocb_time_t xiocb_time; /* timer parameters */
166 xiocb_meminfo_t xiocb_meminfo; /* memory arena info parameters */
167 xiocb_fwinfo_t xiocb_fwinfo; /* firmware information */
168 xiocb_exitstat_t xiocb_exitstat; /* Exit Status */
172 #endif /* CFE_API_INT_H */