xref: /freebsd/stand/uboot/glue.h (revision 2e3f49888ec8851bafb22011533217487764fdb0)
1 /*-
2  * Copyright (c) 2008 Semihalf, Rafal Jaworowski <raj@semihalf.com>
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24  * SUCH DAMAGE.
25  */
26 
27 /*
28  * This is the header file for conveniency wrapper routines (API glue)
29  */
30 
31 #ifndef _API_GLUE_H_
32 #define _API_GLUE_H_
33 
34 #include "api_public.h"
35 
36 /*
37  * Mask used to align the start address for API signature search to 1MiB
38  */
39 #define	API_SIG_SEARCH_MASK	~0x000fffff
40 
41 /*
42  * Search for the API signature within 3MiB of the 1MiB-aligned address that
43  * U-Boot has hinted us.
44  */
45 #define	API_SIG_SEARCH_LEN	0x00300000
46 
47 int syscall(int, int *, ...);
48 extern void *syscall_ptr;
49 
50 int api_parse_cmdline_sig(int argc, char **argv, struct api_signature **sig);
51 int api_search_sig(struct api_signature **sig);
52 
53 #define	UB_MAX_MR	16		/* max mem regions number */
54 #define	UB_MAX_DEV	6		/* max devices number */
55 
56 /*
57  * The ub_ library calls are part of the application, not U-Boot code!  They
58  * are front-end wrappers that are used by the consumer application: they
59  * prepare arguments for particular syscall and jump to the low level
60  * syscall()
61  */
62 
63 /* console */
64 int ub_getc(void);
65 int ub_tstc(void);
66 void ub_putc(char);
67 void ub_puts(const char *);
68 
69 /* system */
70 void ub_reset(void) __dead2;
71 struct sys_info *ub_get_sys_info(void);
72 
73 /* time */
74 void ub_udelay(unsigned long);
75 unsigned long ub_get_timer(unsigned long);
76 
77 /* env vars */
78 char *ub_env_get(const char *);
79 void ub_env_set(const char *, char *);
80 const char *ub_env_enum(const char *);
81 
82 /* devices */
83 int ub_dev_enum(void);
84 int ub_dev_open(int);
85 int ub_dev_close(int);
86 int ub_dev_read(int, void *, lbasize_t, lbastart_t, lbasize_t *);
87 int ub_dev_send(int, void *, int);
88 int ub_dev_recv(int, void *, int, int *);
89 struct device_info *ub_dev_get(int);
90 
91 void ub_dump_di(int);
92 void ub_dump_si(struct sys_info *);
93 char *ub_mem_type(int);
94 char *ub_stor_type(int);
95 
96 #endif /* _API_GLUE_H_ */
97