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