1 /* from: Broadcom Id: cfe_api.c,v 1.18 2006/08/24 02:13:56 binh Exp $ */
4 * Copyright 2000, 2001, 2002
5 * Broadcom Corporation. All rights reserved.
7 * This software is furnished under license and may be used and copied only
8 * in accordance with the following terms and conditions. Subject to these
9 * conditions, you may download, copy, install, use, modify and distribute
10 * modified or unmodified copies of this software in source and/or binary
11 * form. No title or ownership is transferred hereby.
13 * 1) Any source code used, modified or distributed must reproduce and
14 * retain this copyright notice and list of conditions as they appear in
17 * 2) No right is granted to use any trade name, trademark, or logo of
18 * Broadcom Corporation. The "Broadcom Corporation" name may not be
19 * used to endorse or promote products derived from this software
20 * without the prior written permission of Broadcom Corporation.
22 * 3) THIS SOFTWARE IS PROVIDED "AS-IS" AND ANY EXPRESS OR IMPLIED
23 * WARRANTIES, INCLUDING BUT NOT LIMITED TO, ANY IMPLIED WARRANTIES OF
24 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR
25 * NON-INFRINGEMENT ARE DISCLAIMED. IN NO EVENT SHALL BROADCOM BE LIABLE
26 * FOR ANY DAMAGES WHATSOEVER, AND IN PARTICULAR, BROADCOM SHALL NOT BE
27 * LIABLE FOR DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
28 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
29 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
30 * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
31 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
32 * OR OTHERWISE), EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
35 /* *********************************************************************
37 * Broadcom Common Firmware Environment (CFE)
39 * Device Function stubs File: cfe_api.c
41 * This module contains device function stubs (small routines to
42 * call the standard "iocb" interface entry point to CFE).
43 * There should be one routine here per iocb function call.
45 * Authors: Mitch Lichtenberg, Chris Demetriou
47 ********************************************************************* */
49 #include <sys/cdefs.h>
50 __FBSDID("$FreeBSD$");
52 #include <dev/cfe/cfe_api.h>
53 #include <dev/cfe/cfe_api_int.h>
55 /* Cast from a native pointer to a cfe_xptr_t and back. */
56 #define XPTR_FROM_NATIVE(n) ((cfe_xptr_t) (intptr_t) (n))
57 #define NATIVE_FROM_XPTR(x) ((void *) (intptr_t) (x))
59 #ifdef CFE_API_IMPL_NAMESPACE
60 #define cfe_iocb_dispatch(a) __cfe_iocb_dispatch(a)
62 int cfe_iocb_dispatch(cfe_xiocb_t *xiocb);
64 #if defined(CFE_API_common) || defined(CFE_API_ALL)
66 * Declare the dispatch function with args of "intptr_t".
67 * This makes sure whatever model we're compiling in
68 * puts the pointers in a single register. For example,
69 * combining -mlong64 and -mips1 or -mips2 would lead to
70 * trouble, since the handle and IOCB pointer will be
71 * passed in two registers each, and CFE expects one.
74 static int (*cfe_dispfunc)(intptr_t handle, intptr_t xiocb) = 0;
75 static cfe_xuint_t cfe_handle = 0;
78 cfe_init(cfe_xuint_t handle, cfe_xuint_t ept)
80 cfe_dispfunc = NATIVE_FROM_XPTR(ept);
86 cfe_iocb_dispatch(cfe_xiocb_t *xiocb)
88 if (!cfe_dispfunc) return -1;
89 return (*cfe_dispfunc)((intptr_t)cfe_handle, (intptr_t)xiocb);
91 #endif /* CFE_API_common || CFE_API_ALL */
93 #if defined(CFE_API_close) || defined(CFE_API_ALL)
99 xiocb.xiocb_fcode = CFE_CMD_DEV_CLOSE;
100 xiocb.xiocb_status = 0;
101 xiocb.xiocb_handle = handle;
102 xiocb.xiocb_flags = 0;
103 xiocb.xiocb_psize = 0;
105 cfe_iocb_dispatch(&xiocb);
107 return xiocb.xiocb_status;
110 #endif /* CFE_API_close || CFE_API_ALL */
112 #if defined(CFE_API_cpu_start) || defined(CFE_API_ALL)
114 cfe_cpu_start(int cpu, void (*fn)(void), long sp, long gp, long a1)
118 xiocb.xiocb_fcode = CFE_CMD_FW_CPUCTL;
119 xiocb.xiocb_status = 0;
120 xiocb.xiocb_handle = 0;
121 xiocb.xiocb_flags = 0;
122 xiocb.xiocb_psize = sizeof(xiocb_cpuctl_t);
123 xiocb.plist.xiocb_cpuctl.cpu_number = cpu;
124 xiocb.plist.xiocb_cpuctl.cpu_command = CFE_CPU_CMD_START;
125 xiocb.plist.xiocb_cpuctl.gp_val = gp;
126 xiocb.plist.xiocb_cpuctl.sp_val = sp;
127 xiocb.plist.xiocb_cpuctl.a1_val = a1;
128 xiocb.plist.xiocb_cpuctl.start_addr = (long)fn;
130 cfe_iocb_dispatch(&xiocb);
132 return xiocb.xiocb_status;
134 #endif /* CFE_API_cpu_start || CFE_API_ALL */
136 #if defined(CFE_API_cpu_stop) || defined(CFE_API_ALL)
138 cfe_cpu_stop(int cpu)
142 xiocb.xiocb_fcode = CFE_CMD_FW_CPUCTL;
143 xiocb.xiocb_status = 0;
144 xiocb.xiocb_handle = 0;
145 xiocb.xiocb_flags = 0;
146 xiocb.xiocb_psize = sizeof(xiocb_cpuctl_t);
147 xiocb.plist.xiocb_cpuctl.cpu_number = cpu;
148 xiocb.plist.xiocb_cpuctl.cpu_command = CFE_CPU_CMD_STOP;
150 cfe_iocb_dispatch(&xiocb);
152 return xiocb.xiocb_status;
154 #endif /* CFE_API_cpu_stop || CFE_API_ALL */
156 #if defined(CFE_API_enumenv) || defined(CFE_API_ALL)
158 cfe_enumenv(int idx, char *name, int namelen, char *val, int vallen)
162 xiocb.xiocb_fcode = CFE_CMD_ENV_ENUM;
163 xiocb.xiocb_status = 0;
164 xiocb.xiocb_handle = 0;
165 xiocb.xiocb_flags = 0;
166 xiocb.xiocb_psize = sizeof(xiocb_envbuf_t);
167 xiocb.plist.xiocb_envbuf.enum_idx = idx;
168 xiocb.plist.xiocb_envbuf.name_ptr = XPTR_FROM_NATIVE(name);
169 xiocb.plist.xiocb_envbuf.name_length = namelen;
170 xiocb.plist.xiocb_envbuf.val_ptr = XPTR_FROM_NATIVE(val);
171 xiocb.plist.xiocb_envbuf.val_length = vallen;
173 cfe_iocb_dispatch(&xiocb);
175 return xiocb.xiocb_status;
177 #endif /* CFE_API_enumenv || CFE_API_ALL */
179 #if defined(CFE_API_enumdev) || defined(CFE_API_ALL)
181 cfe_enumdev(int idx, char *name, int namelen)
185 xiocb.xiocb_fcode = CFE_CMD_DEV_ENUM;
186 xiocb.xiocb_status = 0;
187 xiocb.xiocb_handle = 0;
188 xiocb.xiocb_flags = 0;
189 xiocb.xiocb_psize = sizeof(xiocb_envbuf_t);
190 xiocb.plist.xiocb_envbuf.enum_idx = idx;
191 xiocb.plist.xiocb_envbuf.name_ptr = XPTR_FROM_NATIVE(name);
192 xiocb.plist.xiocb_envbuf.name_length = namelen;
194 cfe_iocb_dispatch(&xiocb);
196 return xiocb.xiocb_status;
198 #endif /* CFE_API_enumdev || CFE_API_ALL */
200 #if defined(CFE_API_enummem) || defined(CFE_API_ALL)
202 cfe_enummem(int idx, int flags, cfe_xuint_t *start, cfe_xuint_t *length,
207 xiocb.xiocb_fcode = CFE_CMD_FW_MEMENUM;
208 xiocb.xiocb_status = 0;
209 xiocb.xiocb_handle = 0;
210 xiocb.xiocb_flags = flags;
211 xiocb.xiocb_psize = sizeof(xiocb_meminfo_t);
212 xiocb.plist.xiocb_meminfo.mi_idx = idx;
214 cfe_iocb_dispatch(&xiocb);
216 if (xiocb.xiocb_status < 0)
217 return xiocb.xiocb_status;
219 *start = xiocb.plist.xiocb_meminfo.mi_addr;
220 *length = xiocb.plist.xiocb_meminfo.mi_size;
221 *type = xiocb.plist.xiocb_meminfo.mi_type;
225 #endif /* CFE_API_enummem || CFE_API_ALL */
227 #if defined(CFE_API_exit) || defined(CFE_API_ALL)
229 cfe_exit(int warm, int status)
233 xiocb.xiocb_fcode = CFE_CMD_FW_RESTART;
234 xiocb.xiocb_status = 0;
235 xiocb.xiocb_handle = 0;
236 xiocb.xiocb_flags = warm ? CFE_FLG_WARMSTART : 0;
237 xiocb.xiocb_psize = sizeof(xiocb_exitstat_t);
238 xiocb.plist.xiocb_exitstat.status = status;
240 cfe_iocb_dispatch(&xiocb);
242 return xiocb.xiocb_status;
244 #endif /* CFE_API_exit || CFE_API_ALL */
246 #if defined(CFE_API_flushcache) || defined(CFE_API_ALL)
248 cfe_flushcache(int flg)
252 xiocb.xiocb_fcode = CFE_CMD_FW_FLUSHCACHE;
253 xiocb.xiocb_status = 0;
254 xiocb.xiocb_handle = 0;
255 xiocb.xiocb_flags = flg;
256 xiocb.xiocb_psize = 0;
258 cfe_iocb_dispatch(&xiocb);
260 return xiocb.xiocb_status;
262 #endif /* CFE_API_flushcache || CFE_API_ALL */
264 #if defined(CFE_API_getdevinfo) || defined(CFE_API_ALL)
266 cfe_getdevinfo(char *name)
270 xiocb.xiocb_fcode = CFE_CMD_DEV_GETINFO;
271 xiocb.xiocb_status = 0;
272 xiocb.xiocb_handle = 0;
273 xiocb.xiocb_flags = 0;
274 xiocb.xiocb_psize = sizeof(xiocb_buffer_t);
275 xiocb.plist.xiocb_buffer.buf_offset = 0;
276 xiocb.plist.xiocb_buffer.buf_ptr = XPTR_FROM_NATIVE(name);
277 xiocb.plist.xiocb_buffer.buf_length = cfe_strlen(name);
279 cfe_iocb_dispatch(&xiocb);
281 if (xiocb.xiocb_status < 0)
282 return xiocb.xiocb_status;
283 return xiocb.plist.xiocb_buffer.buf_devflags;
285 #endif /* CFE_API_getdevinfo || CFE_API_ALL */
287 #if defined(CFE_API_getenv) || defined(CFE_API_ALL)
289 cfe_getenv(char *name, char *dest, int destlen)
295 xiocb.xiocb_fcode = CFE_CMD_ENV_GET;
296 xiocb.xiocb_status = 0;
297 xiocb.xiocb_handle = 0;
298 xiocb.xiocb_flags = 0;
299 xiocb.xiocb_psize = sizeof(xiocb_envbuf_t);
300 xiocb.plist.xiocb_envbuf.enum_idx = 0;
301 xiocb.plist.xiocb_envbuf.name_ptr = XPTR_FROM_NATIVE(name);
302 xiocb.plist.xiocb_envbuf.name_length = cfe_strlen(name);
303 xiocb.plist.xiocb_envbuf.val_ptr = XPTR_FROM_NATIVE(dest);
304 xiocb.plist.xiocb_envbuf.val_length = destlen;
306 cfe_iocb_dispatch(&xiocb);
308 return xiocb.xiocb_status;
310 #endif /* CFE_API_getenv || CFE_API_ALL */
312 #if defined(CFE_API_getfwinfo) || defined(CFE_API_ALL)
314 cfe_getfwinfo(cfe_fwinfo_t *info)
318 xiocb.xiocb_fcode = CFE_CMD_FW_GETINFO;
319 xiocb.xiocb_status = 0;
320 xiocb.xiocb_handle = 0;
321 xiocb.xiocb_flags = 0;
322 xiocb.xiocb_psize = sizeof(xiocb_fwinfo_t);
324 cfe_iocb_dispatch(&xiocb);
326 if (xiocb.xiocb_status < 0)
327 return xiocb.xiocb_status;
329 info->fwi_version = xiocb.plist.xiocb_fwinfo.fwi_version;
330 info->fwi_totalmem = xiocb.plist.xiocb_fwinfo.fwi_totalmem;
331 info->fwi_flags = xiocb.plist.xiocb_fwinfo.fwi_flags;
332 info->fwi_boardid = xiocb.plist.xiocb_fwinfo.fwi_boardid;
333 info->fwi_bootarea_va = xiocb.plist.xiocb_fwinfo.fwi_bootarea_va;
334 info->fwi_bootarea_pa = xiocb.plist.xiocb_fwinfo.fwi_bootarea_pa;
335 info->fwi_bootarea_size = xiocb.plist.xiocb_fwinfo.fwi_bootarea_size;
337 info->fwi_reserved1 = xiocb.plist.xiocb_fwinfo.fwi_reserved1;
338 info->fwi_reserved2 = xiocb.plist.xiocb_fwinfo.fwi_reserved2;
339 info->fwi_reserved3 = xiocb.plist.xiocb_fwinfo.fwi_reserved3;
344 #endif /* CFE_API_getfwinfo || CFE_API_ALL */
346 #if defined(CFE_API_getstdhandle) || defined(CFE_API_ALL)
348 cfe_getstdhandle(int flg)
352 xiocb.xiocb_fcode = CFE_CMD_DEV_GETHANDLE;
353 xiocb.xiocb_status = 0;
354 xiocb.xiocb_handle = 0;
355 xiocb.xiocb_flags = flg;
356 xiocb.xiocb_psize = 0;
358 cfe_iocb_dispatch(&xiocb);
360 if (xiocb.xiocb_status < 0)
361 return xiocb.xiocb_status;
362 return xiocb.xiocb_handle;
365 #endif /* CFE_API_getstdhandle || CFE_API_ALL */
367 #if defined(CFE_API_getticks) || defined(CFE_API_ALL)
369 #ifdef CFE_API_IMPL_NAMESPACE
377 xiocb.xiocb_fcode = CFE_CMD_FW_GETTIME;
378 xiocb.xiocb_status = 0;
379 xiocb.xiocb_handle = 0;
380 xiocb.xiocb_flags = 0;
381 xiocb.xiocb_psize = sizeof(xiocb_time_t);
382 xiocb.plist.xiocb_time.ticks = 0;
384 cfe_iocb_dispatch(&xiocb);
386 return xiocb.plist.xiocb_time.ticks;
389 #endif /* CFE_API_getticks || CFE_API_ALL */
391 #if defined(CFE_API_inpstat) || defined(CFE_API_ALL)
393 cfe_inpstat(int handle)
397 xiocb.xiocb_fcode = CFE_CMD_DEV_INPSTAT;
398 xiocb.xiocb_status = 0;
399 xiocb.xiocb_handle = handle;
400 xiocb.xiocb_flags = 0;
401 xiocb.xiocb_psize = sizeof(xiocb_inpstat_t);
402 xiocb.plist.xiocb_inpstat.inp_status = 0;
404 cfe_iocb_dispatch(&xiocb);
406 if (xiocb.xiocb_status < 0)
407 return xiocb.xiocb_status;
408 return xiocb.plist.xiocb_inpstat.inp_status;
411 #endif /* CFE_API_inpstat || CFE_API_ALL */
413 #if defined(CFE_API_ioctl) || defined(CFE_API_ALL)
415 cfe_ioctl(int handle, unsigned int ioctlnum, unsigned char *buffer, int length,
416 int *retlen, cfe_xuint_t offset)
420 xiocb.xiocb_fcode = CFE_CMD_DEV_IOCTL;
421 xiocb.xiocb_status = 0;
422 xiocb.xiocb_handle = handle;
423 xiocb.xiocb_flags = 0;
424 xiocb.xiocb_psize = sizeof(xiocb_buffer_t);
425 xiocb.plist.xiocb_buffer.buf_offset = offset;
426 xiocb.plist.xiocb_buffer.buf_ioctlcmd = ioctlnum;
427 xiocb.plist.xiocb_buffer.buf_ptr = XPTR_FROM_NATIVE(buffer);
428 xiocb.plist.xiocb_buffer.buf_length = length;
430 cfe_iocb_dispatch(&xiocb);
433 *retlen = xiocb.plist.xiocb_buffer.buf_retlen;
434 return xiocb.xiocb_status;
436 #endif /* CFE_API_ioctl || CFE_API_ALL */
438 #if defined(CFE_API_open) || defined(CFE_API_ALL)
444 xiocb.xiocb_fcode = CFE_CMD_DEV_OPEN;
445 xiocb.xiocb_status = 0;
446 xiocb.xiocb_handle = 0;
447 xiocb.xiocb_flags = 0;
448 xiocb.xiocb_psize = sizeof(xiocb_buffer_t);
449 xiocb.plist.xiocb_buffer.buf_offset = 0;
450 xiocb.plist.xiocb_buffer.buf_ptr = XPTR_FROM_NATIVE(name);
451 xiocb.plist.xiocb_buffer.buf_length = cfe_strlen(name);
453 cfe_iocb_dispatch(&xiocb);
455 if (xiocb.xiocb_status < 0)
456 return xiocb.xiocb_status;
457 return xiocb.xiocb_handle;
459 #endif /* CFE_API_open || CFE_API_ALL */
461 #if defined(CFE_API_read) || defined(CFE_API_ALL)
463 cfe_read(int handle, unsigned char *buffer, int length)
465 return cfe_readblk(handle, 0, buffer, length);
467 #endif /* CFE_API_read || CFE_API_ALL */
469 #if defined(CFE_API_readblk) || defined(CFE_API_ALL)
471 cfe_readblk(int handle, cfe_xint_t offset, unsigned char *buffer, int length)
475 xiocb.xiocb_fcode = CFE_CMD_DEV_READ;
476 xiocb.xiocb_status = 0;
477 xiocb.xiocb_handle = handle;
478 xiocb.xiocb_flags = 0;
479 xiocb.xiocb_psize = sizeof(xiocb_buffer_t);
480 xiocb.plist.xiocb_buffer.buf_offset = offset;
481 xiocb.plist.xiocb_buffer.buf_ptr = XPTR_FROM_NATIVE(buffer);
482 xiocb.plist.xiocb_buffer.buf_length = length;
484 cfe_iocb_dispatch(&xiocb);
486 if (xiocb.xiocb_status < 0)
487 return xiocb.xiocb_status;
488 return xiocb.plist.xiocb_buffer.buf_retlen;
490 #endif /* CFE_API_readblk || CFE_API_ALL */
492 #if defined(CFE_API_setenv) || defined(CFE_API_ALL)
494 cfe_setenv(char *name, char *val)
498 xiocb.xiocb_fcode = CFE_CMD_ENV_SET;
499 xiocb.xiocb_status = 0;
500 xiocb.xiocb_handle = 0;
501 xiocb.xiocb_flags = 0;
502 xiocb.xiocb_psize = sizeof(xiocb_envbuf_t);
503 xiocb.plist.xiocb_envbuf.enum_idx = 0;
504 xiocb.plist.xiocb_envbuf.name_ptr = XPTR_FROM_NATIVE(name);
505 xiocb.plist.xiocb_envbuf.name_length = cfe_strlen(name);
506 xiocb.plist.xiocb_envbuf.val_ptr = XPTR_FROM_NATIVE(val);
507 xiocb.plist.xiocb_envbuf.val_length = cfe_strlen(val);
509 cfe_iocb_dispatch(&xiocb);
511 return xiocb.xiocb_status;
513 #endif /* CFE_API_setenv || CFE_API_ALL */
515 #if (defined(CFE_API_strlen) || defined(CFE_API_ALL)) \
516 && !defined(CFE_API_STRLEN_CUSTOM)
518 cfe_strlen(char *name)
527 #endif /* CFE_API_strlen || CFE_API_ALL */
529 #if defined(CFE_API_write) || defined(CFE_API_ALL)
531 cfe_write(int handle, unsigned char *buffer, int length)
533 return cfe_writeblk(handle, 0, buffer, length);
535 #endif /* CFE_API_write || CFE_API_ALL */
537 #if defined(CFE_API_writeblk) || defined(CFE_API_ALL)
539 cfe_writeblk(int handle, cfe_xint_t offset, unsigned char *buffer, int length)
543 xiocb.xiocb_fcode = CFE_CMD_DEV_WRITE;
544 xiocb.xiocb_status = 0;
545 xiocb.xiocb_handle = handle;
546 xiocb.xiocb_flags = 0;
547 xiocb.xiocb_psize = sizeof(xiocb_buffer_t);
548 xiocb.plist.xiocb_buffer.buf_offset = offset;
549 xiocb.plist.xiocb_buffer.buf_ptr = XPTR_FROM_NATIVE(buffer);
550 xiocb.plist.xiocb_buffer.buf_length = length;
552 cfe_iocb_dispatch(&xiocb);
554 if (xiocb.xiocb_status < 0)
555 return xiocb.xiocb_status;
556 return xiocb.plist.xiocb_buffer.buf_retlen;
558 #endif /* CFE_API_writeblk || CFE_API_ALL */