xref: /openbmc/u-boot/examples/api/glue.h (revision 5187d8dd)
1 /*
2  * (C) Copyright 2007 Semihalf
3  *
4  * Written by: Rafal Jaworowski <raj@semihalf.com>
5  *
6  * See file CREDITS for list of people who contributed to this
7  * project.
8  *
9  * This program is free software; you can redistribute it and/or
10  * modify it under the terms of the GNU General Public License as
11  * published by the Free Software Foundation; either version 2 of
12  * the License, or (at your option) any later version.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program; if not, write to the Free Software
21  * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
22  * MA 02111-1307 USA
23  *
24  */
25 
26 /*
27  * This is the header file for conveniency wrapper routines (API glue)
28  */
29 
30 #ifndef _API_GLUE_H_
31 #define _API_GLUE_H_
32 
33 #define API_SEARCH_LEN		(3 * 1024 * 1024)	/* 3MB search range */
34 
35 #define UB_MAX_MR	5	/* max mem regions number */
36 #define UB_MAX_DEV	6	/* max devices number */
37 
38 extern void *syscall_ptr;
39 extern uint32_t search_hint;
40 
41 int	syscall(int, int *, ...);
42 int	api_search_sig(struct api_signature **sig);
43 
44 /*
45  * The ub_ library calls are part of the application, not U-Boot code!  They
46  * are front-end wrappers that are used by the consumer application: they
47  * prepare arguments for particular syscall and jump to the low level
48  * syscall()
49  */
50 
51 /* console */
52 int	ub_getc(void);
53 int	ub_tstc(void);
54 void	ub_putc(char c);
55 void	ub_puts(const char *s);
56 
57 /* system */
58 void			ub_reset(void);
59 struct sys_info *	ub_get_sys_info(void);
60 
61 /* time */
62 void		ub_udelay(unsigned long);
63 unsigned long	ub_get_timer(unsigned long);
64 
65 /* env vars */
66 char *		ub_env_get(const char *name);
67 void		ub_env_set(const char *name, char *value);
68 const char *	ub_env_enum(const char *last);
69 
70 /* devices */
71 int			ub_dev_enum(void);
72 int			ub_dev_open(int handle);
73 int			ub_dev_close(int handle);
74 int			ub_dev_read(int handle, void *buf, lbasize_t len,
75 				lbastart_t start, lbasize_t *rlen);
76 int			ub_dev_send(int handle, void *buf, int len);
77 int			ub_dev_recv(int handle, void *buf, int len, int *rlen);
78 struct device_info *	ub_dev_get(int);
79 
80 #endif /* _API_GLUE_H_ */
81