xref: /titanic_52/usr/src/boot/sys/boot/uboot/lib/glue.h (revision 4a5d661a82b942b6538acd26209d959ce98b593a)
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  * $FreeBSD$
27  */
28 
29 /*
30  * This is the header file for conveniency wrapper routines (API glue)
31  */
32 
33 #ifndef _API_GLUE_H_
34 #define _API_GLUE_H_
35 
36 #include "api_public.h"
37 
38 /*
39  * Mask used to align the start address for API signature search to 1MiB
40  */
41 #define	API_SIG_SEARCH_MASK	~0x000fffff
42 
43 #ifdef __mips__
44 /*
45  * On MIPS, U-Boot passes us a hint address, which is very close to the end of
46  * RAM (less than 1MiB), so searching for the API signature within more than
47  * that leads to exception.
48  */
49 #define	API_SIG_SEARCH_LEN	0x00100000
50 #else
51 /*
52  * Search for the API signature within 3MiB of the 1MiB-aligned address that
53  * U-Boot has hinted us.
54  */
55 #define	API_SIG_SEARCH_LEN	0x00300000
56 #endif
57 
58 int syscall(int, int *, ...);
59 void *syscall_ptr;
60 
61 int api_search_sig(struct api_signature **sig);
62 
63 #define	UB_MAX_MR	16		/* max mem regions number */
64 #define	UB_MAX_DEV	6		/* max devices number */
65 
66 /*
67  * The ub_ library calls are part of the application, not U-Boot code!  They
68  * are front-end wrappers that are used by the consumer application: they
69  * prepare arguments for particular syscall and jump to the low level
70  * syscall()
71  */
72 
73 /* console */
74 int ub_getc(void);
75 int ub_tstc(void);
76 void ub_putc(char);
77 void ub_puts(const char *);
78 
79 /* system */
80 void ub_reset(void);
81 struct sys_info *ub_get_sys_info(void);
82 
83 /* time */
84 void ub_udelay(unsigned long);
85 unsigned long ub_get_timer(unsigned long);
86 
87 /* env vars */
88 char *ub_env_get(const char *);
89 void ub_env_set(const char *, char *);
90 const char *ub_env_enum(const char *);
91 
92 /* devices */
93 int ub_dev_enum(void);
94 int ub_dev_open(int);
95 int ub_dev_close(int);
96 int ub_dev_read(int, void *, lbasize_t, lbastart_t, lbasize_t *);
97 int ub_dev_send(int, void *, int);
98 int ub_dev_recv(int, void *, int, int *);
99 struct device_info *ub_dev_get(int);
100 
101 void ub_dump_di(int);
102 void ub_dump_si(struct sys_info *);
103 char *ub_mem_type(int);
104 char *ub_stor_type(int);
105 
106 #endif /* _API_GLUE_H_ */
107