1 /* from: Broadcom Id: cfe_api.c,v 1.18 2006/08/24 02:13:56 binh 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.
37 /* *********************************************************************
39 * Broadcom Common Firmware Environment (CFE)
41 * Device Function stubs File: cfe_api.c
43 * This module contains device function stubs (small routines to
44 * call the standard "iocb" interface entry point to CFE).
45 * There should be one routine here per iocb function call.
47 * Authors: Mitch Lichtenberg, Chris Demetriou
49 ********************************************************************* */
51 #include <sys/cdefs.h>
52 __FBSDID("$FreeBSD$");
54 #include <dev/cfe/cfe_api.h>
55 #include <dev/cfe/cfe_api_int.h>
57 /* Cast from a native pointer to a cfe_xptr_t and back. */
58 #define XPTR_FROM_NATIVE(n) ((cfe_xptr_t) (intptr_t) (n))
59 #define NATIVE_FROM_XPTR(x) ((void *) (intptr_t) (x))
61 #ifdef CFE_API_IMPL_NAMESPACE
62 #define cfe_iocb_dispatch(a) __cfe_iocb_dispatch(a)
64 int cfe_iocb_dispatch(cfe_xiocb_t *xiocb);
66 #if defined(CFE_API_common) || defined(CFE_API_ALL)
68 * Declare the dispatch function with args of "intptr_t".
69 * This makes sure whatever model we're compiling in
70 * puts the pointers in a single register. For example,
71 * combining -mlong64 and -mips1 or -mips2 would lead to
72 * trouble, since the handle and IOCB pointer will be
73 * passed in two registers each, and CFE expects one.
76 static int (*cfe_dispfunc)(intptr_t handle, intptr_t xiocb) = 0;
77 static cfe_xuint_t cfe_handle = 0;
80 cfe_init(cfe_xuint_t handle, cfe_xuint_t ept)
82 cfe_dispfunc = NATIVE_FROM_XPTR(ept);
88 cfe_iocb_dispatch(cfe_xiocb_t *xiocb)
90 if (!cfe_dispfunc) return -1;
91 return (*cfe_dispfunc)((intptr_t)cfe_handle, (intptr_t)xiocb);
93 #endif /* CFE_API_common || CFE_API_ALL */
95 #if defined(CFE_API_close) || defined(CFE_API_ALL)
101 xiocb.xiocb_fcode = CFE_CMD_DEV_CLOSE;
102 xiocb.xiocb_status = 0;
103 xiocb.xiocb_handle = handle;
104 xiocb.xiocb_flags = 0;
105 xiocb.xiocb_psize = 0;
107 cfe_iocb_dispatch(&xiocb);
109 return xiocb.xiocb_status;
112 #endif /* CFE_API_close || CFE_API_ALL */
114 #if defined(CFE_API_cpu_start) || defined(CFE_API_ALL)
116 cfe_cpu_start(int cpu, void (*fn)(void), long sp, long gp, long a1)
120 xiocb.xiocb_fcode = CFE_CMD_FW_CPUCTL;
121 xiocb.xiocb_status = 0;
122 xiocb.xiocb_handle = 0;
123 xiocb.xiocb_flags = 0;
124 xiocb.xiocb_psize = sizeof(xiocb_cpuctl_t);
125 xiocb.plist.xiocb_cpuctl.cpu_number = cpu;
126 xiocb.plist.xiocb_cpuctl.cpu_command = CFE_CPU_CMD_START;
127 xiocb.plist.xiocb_cpuctl.gp_val = gp;
128 xiocb.plist.xiocb_cpuctl.sp_val = sp;
129 xiocb.plist.xiocb_cpuctl.a1_val = a1;
130 xiocb.plist.xiocb_cpuctl.start_addr = (long)fn;
132 cfe_iocb_dispatch(&xiocb);
134 return xiocb.xiocb_status;
136 #endif /* CFE_API_cpu_start || CFE_API_ALL */
138 #if defined(CFE_API_cpu_stop) || defined(CFE_API_ALL)
140 cfe_cpu_stop(int cpu)
144 xiocb.xiocb_fcode = CFE_CMD_FW_CPUCTL;
145 xiocb.xiocb_status = 0;
146 xiocb.xiocb_handle = 0;
147 xiocb.xiocb_flags = 0;
148 xiocb.xiocb_psize = sizeof(xiocb_cpuctl_t);
149 xiocb.plist.xiocb_cpuctl.cpu_number = cpu;
150 xiocb.plist.xiocb_cpuctl.cpu_command = CFE_CPU_CMD_STOP;
152 cfe_iocb_dispatch(&xiocb);
154 return xiocb.xiocb_status;
156 #endif /* CFE_API_cpu_stop || CFE_API_ALL */
158 #if defined(CFE_API_enumenv) || defined(CFE_API_ALL)
160 cfe_enumenv(int idx, char *name, int namelen, char *val, int vallen)
164 xiocb.xiocb_fcode = CFE_CMD_ENV_ENUM;
165 xiocb.xiocb_status = 0;
166 xiocb.xiocb_handle = 0;
167 xiocb.xiocb_flags = 0;
168 xiocb.xiocb_psize = sizeof(xiocb_envbuf_t);
169 xiocb.plist.xiocb_envbuf.enum_idx = idx;
170 xiocb.plist.xiocb_envbuf.name_ptr = XPTR_FROM_NATIVE(name);
171 xiocb.plist.xiocb_envbuf.name_length = namelen;
172 xiocb.plist.xiocb_envbuf.val_ptr = XPTR_FROM_NATIVE(val);
173 xiocb.plist.xiocb_envbuf.val_length = vallen;
175 cfe_iocb_dispatch(&xiocb);
177 return xiocb.xiocb_status;
179 #endif /* CFE_API_enumenv || CFE_API_ALL */
181 #if defined(CFE_API_enumdev) || defined(CFE_API_ALL)
183 cfe_enumdev(int idx, char *name, int namelen)
187 xiocb.xiocb_fcode = CFE_CMD_DEV_ENUM;
188 xiocb.xiocb_status = 0;
189 xiocb.xiocb_handle = 0;
190 xiocb.xiocb_flags = 0;
191 xiocb.xiocb_psize = sizeof(xiocb_envbuf_t);
192 xiocb.plist.xiocb_envbuf.enum_idx = idx;
193 xiocb.plist.xiocb_envbuf.name_ptr = XPTR_FROM_NATIVE(name);
194 xiocb.plist.xiocb_envbuf.name_length = namelen;
196 cfe_iocb_dispatch(&xiocb);
198 return xiocb.xiocb_status;
200 #endif /* CFE_API_enumdev || CFE_API_ALL */
202 #if defined(CFE_API_enummem) || defined(CFE_API_ALL)
204 cfe_enummem(int idx, int flags, cfe_xuint_t *start, cfe_xuint_t *length,
209 xiocb.xiocb_fcode = CFE_CMD_FW_MEMENUM;
210 xiocb.xiocb_status = 0;
211 xiocb.xiocb_handle = 0;
212 xiocb.xiocb_flags = flags;
213 xiocb.xiocb_psize = sizeof(xiocb_meminfo_t);
214 xiocb.plist.xiocb_meminfo.mi_idx = idx;
216 cfe_iocb_dispatch(&xiocb);
218 if (xiocb.xiocb_status < 0)
219 return xiocb.xiocb_status;
221 *start = xiocb.plist.xiocb_meminfo.mi_addr;
222 *length = xiocb.plist.xiocb_meminfo.mi_size;
223 *type = xiocb.plist.xiocb_meminfo.mi_type;
227 #endif /* CFE_API_enummem || CFE_API_ALL */
229 #if defined(CFE_API_exit) || defined(CFE_API_ALL)
231 cfe_exit(int warm, int status)
235 xiocb.xiocb_fcode = CFE_CMD_FW_RESTART;
236 xiocb.xiocb_status = 0;
237 xiocb.xiocb_handle = 0;
238 xiocb.xiocb_flags = warm ? CFE_FLG_WARMSTART : 0;
239 xiocb.xiocb_psize = sizeof(xiocb_exitstat_t);
240 xiocb.plist.xiocb_exitstat.status = status;
242 cfe_iocb_dispatch(&xiocb);
244 return xiocb.xiocb_status;
246 #endif /* CFE_API_exit || CFE_API_ALL */
248 #if defined(CFE_API_flushcache) || defined(CFE_API_ALL)
250 cfe_flushcache(int flg)
254 xiocb.xiocb_fcode = CFE_CMD_FW_FLUSHCACHE;
255 xiocb.xiocb_status = 0;
256 xiocb.xiocb_handle = 0;
257 xiocb.xiocb_flags = flg;
258 xiocb.xiocb_psize = 0;
260 cfe_iocb_dispatch(&xiocb);
262 return xiocb.xiocb_status;
264 #endif /* CFE_API_flushcache || CFE_API_ALL */
266 #if defined(CFE_API_getdevinfo) || defined(CFE_API_ALL)
268 cfe_getdevinfo(char *name)
272 xiocb.xiocb_fcode = CFE_CMD_DEV_GETINFO;
273 xiocb.xiocb_status = 0;
274 xiocb.xiocb_handle = 0;
275 xiocb.xiocb_flags = 0;
276 xiocb.xiocb_psize = sizeof(xiocb_buffer_t);
277 xiocb.plist.xiocb_buffer.buf_offset = 0;
278 xiocb.plist.xiocb_buffer.buf_ptr = XPTR_FROM_NATIVE(name);
279 xiocb.plist.xiocb_buffer.buf_length = cfe_strlen(name);
281 cfe_iocb_dispatch(&xiocb);
283 if (xiocb.xiocb_status < 0)
284 return xiocb.xiocb_status;
285 return xiocb.plist.xiocb_buffer.buf_devflags;
287 #endif /* CFE_API_getdevinfo || CFE_API_ALL */
289 #if defined(CFE_API_getenv) || defined(CFE_API_ALL)
291 cfe_getenv(char *name, char *dest, int destlen)
297 xiocb.xiocb_fcode = CFE_CMD_ENV_GET;
298 xiocb.xiocb_status = 0;
299 xiocb.xiocb_handle = 0;
300 xiocb.xiocb_flags = 0;
301 xiocb.xiocb_psize = sizeof(xiocb_envbuf_t);
302 xiocb.plist.xiocb_envbuf.enum_idx = 0;
303 xiocb.plist.xiocb_envbuf.name_ptr = XPTR_FROM_NATIVE(name);
304 xiocb.plist.xiocb_envbuf.name_length = cfe_strlen(name);
305 xiocb.plist.xiocb_envbuf.val_ptr = XPTR_FROM_NATIVE(dest);
306 xiocb.plist.xiocb_envbuf.val_length = destlen;
308 cfe_iocb_dispatch(&xiocb);
310 return xiocb.xiocb_status;
312 #endif /* CFE_API_getenv || CFE_API_ALL */
314 #if defined(CFE_API_getfwinfo) || defined(CFE_API_ALL)
316 cfe_getfwinfo(cfe_fwinfo_t *info)
320 xiocb.xiocb_fcode = CFE_CMD_FW_GETINFO;
321 xiocb.xiocb_status = 0;
322 xiocb.xiocb_handle = 0;
323 xiocb.xiocb_flags = 0;
324 xiocb.xiocb_psize = sizeof(xiocb_fwinfo_t);
326 cfe_iocb_dispatch(&xiocb);
328 if (xiocb.xiocb_status < 0)
329 return xiocb.xiocb_status;
331 info->fwi_version = xiocb.plist.xiocb_fwinfo.fwi_version;
332 info->fwi_totalmem = xiocb.plist.xiocb_fwinfo.fwi_totalmem;
333 info->fwi_flags = xiocb.plist.xiocb_fwinfo.fwi_flags;
334 info->fwi_boardid = xiocb.plist.xiocb_fwinfo.fwi_boardid;
335 info->fwi_bootarea_va = xiocb.plist.xiocb_fwinfo.fwi_bootarea_va;
336 info->fwi_bootarea_pa = xiocb.plist.xiocb_fwinfo.fwi_bootarea_pa;
337 info->fwi_bootarea_size = xiocb.plist.xiocb_fwinfo.fwi_bootarea_size;
339 info->fwi_reserved1 = xiocb.plist.xiocb_fwinfo.fwi_reserved1;
340 info->fwi_reserved2 = xiocb.plist.xiocb_fwinfo.fwi_reserved2;
341 info->fwi_reserved3 = xiocb.plist.xiocb_fwinfo.fwi_reserved3;
346 #endif /* CFE_API_getfwinfo || CFE_API_ALL */
348 #if defined(CFE_API_getstdhandle) || defined(CFE_API_ALL)
350 cfe_getstdhandle(int flg)
354 xiocb.xiocb_fcode = CFE_CMD_DEV_GETHANDLE;
355 xiocb.xiocb_status = 0;
356 xiocb.xiocb_handle = 0;
357 xiocb.xiocb_flags = flg;
358 xiocb.xiocb_psize = 0;
360 cfe_iocb_dispatch(&xiocb);
362 if (xiocb.xiocb_status < 0)
363 return xiocb.xiocb_status;
364 return xiocb.xiocb_handle;
367 #endif /* CFE_API_getstdhandle || CFE_API_ALL */
369 #if defined(CFE_API_getticks) || defined(CFE_API_ALL)
371 #ifdef CFE_API_IMPL_NAMESPACE
379 xiocb.xiocb_fcode = CFE_CMD_FW_GETTIME;
380 xiocb.xiocb_status = 0;
381 xiocb.xiocb_handle = 0;
382 xiocb.xiocb_flags = 0;
383 xiocb.xiocb_psize = sizeof(xiocb_time_t);
384 xiocb.plist.xiocb_time.ticks = 0;
386 cfe_iocb_dispatch(&xiocb);
388 return xiocb.plist.xiocb_time.ticks;
391 #endif /* CFE_API_getticks || CFE_API_ALL */
393 #if defined(CFE_API_inpstat) || defined(CFE_API_ALL)
395 cfe_inpstat(int handle)
399 xiocb.xiocb_fcode = CFE_CMD_DEV_INPSTAT;
400 xiocb.xiocb_status = 0;
401 xiocb.xiocb_handle = handle;
402 xiocb.xiocb_flags = 0;
403 xiocb.xiocb_psize = sizeof(xiocb_inpstat_t);
404 xiocb.plist.xiocb_inpstat.inp_status = 0;
406 cfe_iocb_dispatch(&xiocb);
408 if (xiocb.xiocb_status < 0)
409 return xiocb.xiocb_status;
410 return xiocb.plist.xiocb_inpstat.inp_status;
413 #endif /* CFE_API_inpstat || CFE_API_ALL */
415 #if defined(CFE_API_ioctl) || defined(CFE_API_ALL)
417 cfe_ioctl(int handle, unsigned int ioctlnum, unsigned char *buffer, int length,
418 int *retlen, cfe_xuint_t offset)
422 xiocb.xiocb_fcode = CFE_CMD_DEV_IOCTL;
423 xiocb.xiocb_status = 0;
424 xiocb.xiocb_handle = handle;
425 xiocb.xiocb_flags = 0;
426 xiocb.xiocb_psize = sizeof(xiocb_buffer_t);
427 xiocb.plist.xiocb_buffer.buf_offset = offset;
428 xiocb.plist.xiocb_buffer.buf_ioctlcmd = ioctlnum;
429 xiocb.plist.xiocb_buffer.buf_ptr = XPTR_FROM_NATIVE(buffer);
430 xiocb.plist.xiocb_buffer.buf_length = length;
432 cfe_iocb_dispatch(&xiocb);
435 *retlen = xiocb.plist.xiocb_buffer.buf_retlen;
436 return xiocb.xiocb_status;
438 #endif /* CFE_API_ioctl || CFE_API_ALL */
440 #if defined(CFE_API_open) || defined(CFE_API_ALL)
446 xiocb.xiocb_fcode = CFE_CMD_DEV_OPEN;
447 xiocb.xiocb_status = 0;
448 xiocb.xiocb_handle = 0;
449 xiocb.xiocb_flags = 0;
450 xiocb.xiocb_psize = sizeof(xiocb_buffer_t);
451 xiocb.plist.xiocb_buffer.buf_offset = 0;
452 xiocb.plist.xiocb_buffer.buf_ptr = XPTR_FROM_NATIVE(name);
453 xiocb.plist.xiocb_buffer.buf_length = cfe_strlen(name);
455 cfe_iocb_dispatch(&xiocb);
457 if (xiocb.xiocb_status < 0)
458 return xiocb.xiocb_status;
459 return xiocb.xiocb_handle;
461 #endif /* CFE_API_open || CFE_API_ALL */
463 #if defined(CFE_API_read) || defined(CFE_API_ALL)
465 cfe_read(int handle, unsigned char *buffer, int length)
467 return cfe_readblk(handle, 0, buffer, length);
469 #endif /* CFE_API_read || CFE_API_ALL */
471 #if defined(CFE_API_readblk) || defined(CFE_API_ALL)
473 cfe_readblk(int handle, cfe_xint_t offset, unsigned char *buffer, int length)
477 xiocb.xiocb_fcode = CFE_CMD_DEV_READ;
478 xiocb.xiocb_status = 0;
479 xiocb.xiocb_handle = handle;
480 xiocb.xiocb_flags = 0;
481 xiocb.xiocb_psize = sizeof(xiocb_buffer_t);
482 xiocb.plist.xiocb_buffer.buf_offset = offset;
483 xiocb.plist.xiocb_buffer.buf_ptr = XPTR_FROM_NATIVE(buffer);
484 xiocb.plist.xiocb_buffer.buf_length = length;
486 cfe_iocb_dispatch(&xiocb);
488 if (xiocb.xiocb_status < 0)
489 return xiocb.xiocb_status;
490 return xiocb.plist.xiocb_buffer.buf_retlen;
492 #endif /* CFE_API_readblk || CFE_API_ALL */
494 #if defined(CFE_API_setenv) || defined(CFE_API_ALL)
496 cfe_setenv(char *name, char *val)
500 xiocb.xiocb_fcode = CFE_CMD_ENV_SET;
501 xiocb.xiocb_status = 0;
502 xiocb.xiocb_handle = 0;
503 xiocb.xiocb_flags = 0;
504 xiocb.xiocb_psize = sizeof(xiocb_envbuf_t);
505 xiocb.plist.xiocb_envbuf.enum_idx = 0;
506 xiocb.plist.xiocb_envbuf.name_ptr = XPTR_FROM_NATIVE(name);
507 xiocb.plist.xiocb_envbuf.name_length = cfe_strlen(name);
508 xiocb.plist.xiocb_envbuf.val_ptr = XPTR_FROM_NATIVE(val);
509 xiocb.plist.xiocb_envbuf.val_length = cfe_strlen(val);
511 cfe_iocb_dispatch(&xiocb);
513 return xiocb.xiocb_status;
515 #endif /* CFE_API_setenv || CFE_API_ALL */
517 #if (defined(CFE_API_strlen) || defined(CFE_API_ALL)) \
518 && !defined(CFE_API_STRLEN_CUSTOM)
520 cfe_strlen(char *name)
529 #endif /* CFE_API_strlen || CFE_API_ALL */
531 #if defined(CFE_API_write) || defined(CFE_API_ALL)
533 cfe_write(int handle, unsigned char *buffer, int length)
535 return cfe_writeblk(handle, 0, buffer, length);
537 #endif /* CFE_API_write || CFE_API_ALL */
539 #if defined(CFE_API_writeblk) || defined(CFE_API_ALL)
541 cfe_writeblk(int handle, cfe_xint_t offset, unsigned char *buffer, int length)
545 xiocb.xiocb_fcode = CFE_CMD_DEV_WRITE;
546 xiocb.xiocb_status = 0;
547 xiocb.xiocb_handle = handle;
548 xiocb.xiocb_flags = 0;
549 xiocb.xiocb_psize = sizeof(xiocb_buffer_t);
550 xiocb.plist.xiocb_buffer.buf_offset = offset;
551 xiocb.plist.xiocb_buffer.buf_ptr = XPTR_FROM_NATIVE(buffer);
552 xiocb.plist.xiocb_buffer.buf_length = length;
554 cfe_iocb_dispatch(&xiocb);
556 if (xiocb.xiocb_status < 0)
557 return xiocb.xiocb_status;
558 return xiocb.plist.xiocb_buffer.buf_retlen;
560 #endif /* CFE_API_writeblk || CFE_API_ALL */