xref: /OK3568_Linux_fs/kernel/arch/mips/fw/cfe/cfe_api_int.h (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun /* SPDX-License-Identifier: GPL-2.0-or-later */
2*4882a593Smuzhiyun /*
3*4882a593Smuzhiyun  * Copyright (C) 2000, 2001, 2002 Broadcom Corporation
4*4882a593Smuzhiyun  */
5*4882a593Smuzhiyun #ifndef CFE_API_INT_H
6*4882a593Smuzhiyun #define CFE_API_INT_H
7*4882a593Smuzhiyun 
8*4882a593Smuzhiyun /*
9*4882a593Smuzhiyun  * Constants.
10*4882a593Smuzhiyun  */
11*4882a593Smuzhiyun #define CFE_CMD_FW_GETINFO	0
12*4882a593Smuzhiyun #define CFE_CMD_FW_RESTART	1
13*4882a593Smuzhiyun #define CFE_CMD_FW_BOOT		2
14*4882a593Smuzhiyun #define CFE_CMD_FW_CPUCTL	3
15*4882a593Smuzhiyun #define CFE_CMD_FW_GETTIME      4
16*4882a593Smuzhiyun #define CFE_CMD_FW_MEMENUM	5
17*4882a593Smuzhiyun #define CFE_CMD_FW_FLUSHCACHE	6
18*4882a593Smuzhiyun 
19*4882a593Smuzhiyun #define CFE_CMD_DEV_GETHANDLE	9
20*4882a593Smuzhiyun #define CFE_CMD_DEV_ENUM	10
21*4882a593Smuzhiyun #define CFE_CMD_DEV_OPEN	11
22*4882a593Smuzhiyun #define CFE_CMD_DEV_INPSTAT	12
23*4882a593Smuzhiyun #define CFE_CMD_DEV_READ	13
24*4882a593Smuzhiyun #define CFE_CMD_DEV_WRITE	14
25*4882a593Smuzhiyun #define CFE_CMD_DEV_IOCTL	15
26*4882a593Smuzhiyun #define CFE_CMD_DEV_CLOSE	16
27*4882a593Smuzhiyun #define CFE_CMD_DEV_GETINFO	17
28*4882a593Smuzhiyun 
29*4882a593Smuzhiyun #define CFE_CMD_ENV_ENUM	20
30*4882a593Smuzhiyun #define CFE_CMD_ENV_GET		22
31*4882a593Smuzhiyun #define CFE_CMD_ENV_SET		23
32*4882a593Smuzhiyun #define CFE_CMD_ENV_DEL		24
33*4882a593Smuzhiyun 
34*4882a593Smuzhiyun #define CFE_CMD_MAX		32
35*4882a593Smuzhiyun 
36*4882a593Smuzhiyun #define CFE_CMD_VENDOR_USE	0x8000	/* codes above this are for customer use */
37*4882a593Smuzhiyun 
38*4882a593Smuzhiyun /*
39*4882a593Smuzhiyun  * Structures.
40*4882a593Smuzhiyun  */
41*4882a593Smuzhiyun 
42*4882a593Smuzhiyun /* eeek, signed "pointers" */
43*4882a593Smuzhiyun typedef s64 cfe_xptr_t;
44*4882a593Smuzhiyun 
45*4882a593Smuzhiyun struct xiocb_buffer {
46*4882a593Smuzhiyun 	u64 buf_offset;		/* offset on device (bytes) */
47*4882a593Smuzhiyun 	cfe_xptr_t  buf_ptr;		/* pointer to a buffer */
48*4882a593Smuzhiyun 	u64 buf_length;		/* length of this buffer */
49*4882a593Smuzhiyun 	u64 buf_retlen;		/* returned length (for read ops) */
50*4882a593Smuzhiyun 	u64 buf_ioctlcmd;	/* IOCTL command (used only for IOCTLs) */
51*4882a593Smuzhiyun };
52*4882a593Smuzhiyun 
53*4882a593Smuzhiyun struct xiocb_inpstat {
54*4882a593Smuzhiyun 	u64 inp_status;		/* 1 means input available */
55*4882a593Smuzhiyun };
56*4882a593Smuzhiyun 
57*4882a593Smuzhiyun struct xiocb_envbuf {
58*4882a593Smuzhiyun 	s64 enum_idx;		/* 0-based enumeration index */
59*4882a593Smuzhiyun 	cfe_xptr_t name_ptr;		/* name string buffer */
60*4882a593Smuzhiyun 	s64 name_length;		/* size of name buffer */
61*4882a593Smuzhiyun 	cfe_xptr_t val_ptr;		/* value string buffer */
62*4882a593Smuzhiyun 	s64 val_length;		/* size of value string buffer */
63*4882a593Smuzhiyun };
64*4882a593Smuzhiyun 
65*4882a593Smuzhiyun struct xiocb_cpuctl {
66*4882a593Smuzhiyun 	u64 cpu_number;		/* cpu number to control */
67*4882a593Smuzhiyun 	u64 cpu_command;	/* command to issue to CPU */
68*4882a593Smuzhiyun 	u64 start_addr;		/* CPU start address */
69*4882a593Smuzhiyun 	u64 gp_val;		/* starting GP value */
70*4882a593Smuzhiyun 	u64 sp_val;		/* starting SP value */
71*4882a593Smuzhiyun 	u64 a1_val;		/* starting A1 value */
72*4882a593Smuzhiyun };
73*4882a593Smuzhiyun 
74*4882a593Smuzhiyun struct xiocb_time {
75*4882a593Smuzhiyun 	s64 ticks;		/* current time in ticks */
76*4882a593Smuzhiyun };
77*4882a593Smuzhiyun 
78*4882a593Smuzhiyun struct xiocb_exitstat{
79*4882a593Smuzhiyun 	s64 status;
80*4882a593Smuzhiyun };
81*4882a593Smuzhiyun 
82*4882a593Smuzhiyun struct xiocb_meminfo {
83*4882a593Smuzhiyun 	s64 mi_idx;		/* 0-based enumeration index */
84*4882a593Smuzhiyun 	s64 mi_type;		/* type of memory block */
85*4882a593Smuzhiyun 	u64 mi_addr;		/* physical start address */
86*4882a593Smuzhiyun 	u64 mi_size;		/* block size */
87*4882a593Smuzhiyun };
88*4882a593Smuzhiyun 
89*4882a593Smuzhiyun struct xiocb_fwinfo {
90*4882a593Smuzhiyun 	s64 fwi_version;		/* major, minor, eco version */
91*4882a593Smuzhiyun 	s64 fwi_totalmem;	/* total installed mem */
92*4882a593Smuzhiyun 	s64 fwi_flags;		/* various flags */
93*4882a593Smuzhiyun 	s64 fwi_boardid;		/* board ID */
94*4882a593Smuzhiyun 	s64 fwi_bootarea_va;	/* VA of boot area */
95*4882a593Smuzhiyun 	s64 fwi_bootarea_pa;	/* PA of boot area */
96*4882a593Smuzhiyun 	s64 fwi_bootarea_size;	/* size of boot area */
97*4882a593Smuzhiyun 	s64 fwi_reserved1;
98*4882a593Smuzhiyun 	s64 fwi_reserved2;
99*4882a593Smuzhiyun 	s64 fwi_reserved3;
100*4882a593Smuzhiyun };
101*4882a593Smuzhiyun 
102*4882a593Smuzhiyun struct cfe_xiocb {
103*4882a593Smuzhiyun 	u64 xiocb_fcode;	/* IOCB function code */
104*4882a593Smuzhiyun 	s64 xiocb_status;	/* return status */
105*4882a593Smuzhiyun 	s64 xiocb_handle;	/* file/device handle */
106*4882a593Smuzhiyun 	u64 xiocb_flags;	/* flags for this IOCB */
107*4882a593Smuzhiyun 	u64 xiocb_psize;	/* size of parameter list */
108*4882a593Smuzhiyun 	union {
109*4882a593Smuzhiyun 		/* buffer parameters */
110*4882a593Smuzhiyun 		struct xiocb_buffer xiocb_buffer;
111*4882a593Smuzhiyun 
112*4882a593Smuzhiyun 		/* input status parameters */
113*4882a593Smuzhiyun 		struct xiocb_inpstat xiocb_inpstat;
114*4882a593Smuzhiyun 
115*4882a593Smuzhiyun 		/* environment function parameters */
116*4882a593Smuzhiyun 		struct xiocb_envbuf xiocb_envbuf;
117*4882a593Smuzhiyun 
118*4882a593Smuzhiyun 		/* CPU control parameters */
119*4882a593Smuzhiyun 		struct xiocb_cpuctl xiocb_cpuctl;
120*4882a593Smuzhiyun 
121*4882a593Smuzhiyun 		/* timer parameters */
122*4882a593Smuzhiyun 		struct xiocb_time xiocb_time;
123*4882a593Smuzhiyun 
124*4882a593Smuzhiyun 		/* memory arena info parameters */
125*4882a593Smuzhiyun 		struct xiocb_meminfo xiocb_meminfo;
126*4882a593Smuzhiyun 
127*4882a593Smuzhiyun 		/* firmware information */
128*4882a593Smuzhiyun 		struct xiocb_fwinfo xiocb_fwinfo;
129*4882a593Smuzhiyun 
130*4882a593Smuzhiyun 		/* Exit Status */
131*4882a593Smuzhiyun 		struct xiocb_exitstat xiocb_exitstat;
132*4882a593Smuzhiyun 	} plist;
133*4882a593Smuzhiyun };
134*4882a593Smuzhiyun 
135*4882a593Smuzhiyun #endif /* CFE_API_INT_H */
136