WebSVN – HelenOS – Diff – /branches/dd/boot/genarch/ofw.h


/*
 * Copyright (c) 2005 Martin Decky
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * - Redistributions of source code must retain the above copyright
 *   notice, this list of conditions and the following disclaimer.
 * - Redistributions in binary form must reproduce the above copyright
 *   notice, this list of conditions and the following disclaimer in the
 *   documentation and/or other materials provided with the distribution.
 * - The name of the author may not be used to endorse or promote products
 *   derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
 
#ifndef BOOT_OFW_H_
#define BOOT_OFW_H_
 
#include <types.h>
#include <stdarg.h>
 
#define BUF_SIZE        1024
 
#define MEMMAP_MAX_RECORDS  32
 
#define MAX_OFW_ARGS            12
 
typedef unative_t ofw_arg_t;
typedef unsigned int ihandle;
typedef unsigned int phandle;
 
/** OpenFirmware command structure
 *
 */
typedef struct {
    ofw_arg_t service;      /**< Command name. */
    ofw_arg_t nargs;        /**< Number of in arguments. */
    ofw_arg_t nret;         /**< Number of out arguments. */
    ofw_arg_t args[MAX_OFW_ARGS];   /**< List of arguments. */
} ofw_args_t;
 
typedef struct {
    void *start;
    uint32_t size;
} memzone_t;
 
typedef struct {
    uint32_t total;
    uint32_t count;
    memzone_t zones[MEMMAP_MAX_RECORDS];
} memmap_t;
 
typedef struct {
    void *addr;
    uint32_t width;
    uint32_t height;
    uint32_t bpp;
    uint32_t scanline;
} screen_t;
 
typedef struct {
    void *addr;
    uint32_t size;
} keyboard_t;
 
typedef struct {
    uint32_t info;
    uint32_t addr_hi;
    uint32_t addr_lo;
} pci_addr_t;
 
typedef struct {
    pci_addr_t addr;
    uint32_t size_hi;
    uint32_t size_lo;
} pci_reg_t;
 
extern uintptr_t ofw_cif;
 
extern phandle ofw_chosen;
extern ihandle ofw_stdout;
extern phandle ofw_root;
extern ihandle ofw_mmu;
extern phandle ofw_memory;
extern phandle ofw_aliases;
 
extern void ofw_init(void);
 
extern void ofw_write(const char *str, const int len);
 
extern int ofw_get_property(const phandle device, const char *name, void *buf, const int buflen);
extern int ofw_get_proplen(const phandle device, const char *name);
extern int ofw_next_property(const phandle device, char *previous, char *buf);
 
extern phandle ofw_get_child_node(const phandle node);
extern phandle ofw_get_peer_node(const phandle node);
extern phandle ofw_find_device(const char *name);
 
extern int ofw_package_to_path(const phandle device, char *buf, const int buflen);
 
extern int ofw(ofw_args_t *arg);
extern unsigned long ofw_call(const char *service, const int nargs, const int nret, ofw_arg_t *rets, ...);
extern unsigned int ofw_get_address_cells(const phandle device);
extern unsigned int ofw_get_size_cells(const phandle device);
extern void *ofw_translate(const void *virt);
extern int ofw_translate_failed(ofw_arg_t flag);
extern void *ofw_claim(const void *virt, const int len);
extern int ofw_map(const void *phys, const void *virt, const int size, const int mode);
extern int ofw_memmap(memmap_t *map);
extern int ofw_screen(screen_t *screen);
extern int ofw_keyboard(keyboard_t *keyboard);
extern void ofw_quiesce(void);
 
#endif
 

Rev 1947	Rev 2071
1	/*	1	/*
2	* Copyright (C) 2005 Martin Decky	2	* Copyright (c) 2005 Martin Decky
3	* All rights reserved.	3	* All rights reserved.
4	*	4	*
5	* Redistribution and use in source and binary forms, with or without	5	* Redistribution and use in source and binary forms, with or without
6	* modification, are permitted provided that the following conditions	6	* modification, are permitted provided that the following conditions
7	* are met:	7	* are met:
8	*	8	*
9	* - Redistributions of source code must retain the above copyright	9	* - Redistributions of source code must retain the above copyright
10	* notice, this list of conditions and the following disclaimer.	10	* notice, this list of conditions and the following disclaimer.
11	* - Redistributions in binary form must reproduce the above copyright	11	* - Redistributions in binary form must reproduce the above copyright
12	* notice, this list of conditions and the following disclaimer in the	12	* notice, this list of conditions and the following disclaimer in the
13	* documentation and/or other materials provided with the distribution.	13	* documentation and/or other materials provided with the distribution.
14	* - The name of the author may not be used to endorse or promote products	14	* - The name of the author may not be used to endorse or promote products
15	* derived from this software without specific prior written permission.	15	* derived from this software without specific prior written permission.
16	*	16	*
17	* THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR	17	* THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18	* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES	18	* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19	* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.	19	* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20	* IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,	20	* IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21	* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT	21	* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22	* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,	22	* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23	* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY	23	* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24	* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT	24	* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25	* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF	25	* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26	* THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.	26	* THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27	*/	27	*/
28		28
29	#ifndef BOOT_OFW_H_	29	#ifndef BOOT_OFW_H_
30	#define BOOT_OFW_H_	30	#define BOOT_OFW_H_
31		31
32	#include <types.h>	32	#include <types.h>
33	#include <stdarg.h>	33	#include <stdarg.h>
34		34
35	#define BUF_SIZE 1024	35	#define BUF_SIZE 1024
36		36
37	#define MEMMAP_MAX_RECORDS 32	37	#define MEMMAP_MAX_RECORDS 32
38		38
39	#define MAX_OFW_ARGS 12	39	#define MAX_OFW_ARGS 12
40		40
41	typedef unative_t ofw_arg_t;	41	typedef unative_t ofw_arg_t;
42	typedef unsigned int ihandle;	42	typedef unsigned int ihandle;
43	typedef unsigned int phandle;	43	typedef unsigned int phandle;
44		44
45	/** OpenFirmware command structure	45	/** OpenFirmware command structure
46	*	46	*
47	*/	47	*/
48	typedef struct {	48	typedef struct {
49	ofw_arg_t service; /*< Command name. /	49	ofw_arg_t service; /*< Command name. /
50	ofw_arg_t nargs; /*< Number of in arguments. /	50	ofw_arg_t nargs; /*< Number of in arguments. /
51	ofw_arg_t nret; /*< Number of out arguments. /	51	ofw_arg_t nret; /*< Number of out arguments. /
52	ofw_arg_t args[MAX_OFW_ARGS]; /*< List of arguments. /	52	ofw_arg_t args[MAX_OFW_ARGS]; /*< List of arguments. /
53	} ofw_args_t;	53	} ofw_args_t;
54		54
55	typedef struct {	55	typedef struct {
56	void *start;	56	void *start;
57	uint32_t size;	57	uint32_t size;
58	} memzone_t;	58	} memzone_t;
59		59
60	typedef struct {	60	typedef struct {
61	uint32_t total;	61	uint32_t total;
62	uint32_t count;	62	uint32_t count;
63	memzone_t zones[MEMMAP_MAX_RECORDS];	63	memzone_t zones[MEMMAP_MAX_RECORDS];
64	} memmap_t;	64	} memmap_t;
65		65
66	typedef struct {	66	typedef struct {
67	void *addr;	67	void *addr;
68	uint32_t width;	68	uint32_t width;
69	uint32_t height;	69	uint32_t height;
70	uint32_t bpp;	70	uint32_t bpp;
71	uint32_t scanline;	71	uint32_t scanline;
72	} screen_t;	72	} screen_t;
73		73
74	typedef struct {	74	typedef struct {
75	void *addr;	75	void *addr;
76	uint32_t size;	76	uint32_t size;
77	} keyboard_t;	77	} keyboard_t;
78		78
79	typedef struct {	79	typedef struct {
80	uint32_t info;	80	uint32_t info;
81	uint32_t addr_hi;	81	uint32_t addr_hi;
82	uint32_t addr_lo;	82	uint32_t addr_lo;
83	} pci_addr_t;	83	} pci_addr_t;
84		84
85	typedef struct {	85	typedef struct {
86	pci_addr_t addr;	86	pci_addr_t addr;
87	uint32_t size_hi;	87	uint32_t size_hi;
88	uint32_t size_lo;	88	uint32_t size_lo;
89	} pci_reg_t;	89	} pci_reg_t;
90		90
91	extern uintptr_t ofw_cif;	91	extern uintptr_t ofw_cif;
92		92
93	extern phandle ofw_chosen;	93	extern phandle ofw_chosen;
94	extern ihandle ofw_stdout;	94	extern ihandle ofw_stdout;
95	extern phandle ofw_root;	95	extern phandle ofw_root;
96	extern ihandle ofw_mmu;	96	extern ihandle ofw_mmu;
97	extern phandle ofw_memory;	97	extern phandle ofw_memory;
98	extern phandle ofw_aliases;	98	extern phandle ofw_aliases;
99		99
100	extern void ofw_init(void);	100	extern void ofw_init(void);
101		101
102	extern void ofw_write(const char *str, const int len);	102	extern void ofw_write(const char *str, const int len);
103		103
104	extern int ofw_get_property(const phandle device, const char name, void buf, const int buflen);	104	extern int ofw_get_property(const phandle device, const char name, void buf, const int buflen);
105	extern int ofw_get_proplen(const phandle device, const char *name);	105	extern int ofw_get_proplen(const phandle device, const char *name);
106	extern int ofw_next_property(const phandle device, char previous, char buf);	106	extern int ofw_next_property(const phandle device, char previous, char buf);
107		107
108	extern phandle ofw_get_child_node(const phandle node);	108	extern phandle ofw_get_child_node(const phandle node);
109	extern phandle ofw_get_peer_node(const phandle node);	109	extern phandle ofw_get_peer_node(const phandle node);
110	extern phandle ofw_find_device(const char *name);	110	extern phandle ofw_find_device(const char *name);
111		111
112	extern int ofw_package_to_path(const phandle device, char *buf, const int buflen);	112	extern int ofw_package_to_path(const phandle device, char *buf, const int buflen);
113		113
114	extern int ofw(ofw_args_t *arg);	114	extern int ofw(ofw_args_t *arg);
115	extern unsigned long ofw_call(const char service, const int nargs, const int nret, ofw_arg_t rets, ...);	115	extern unsigned long ofw_call(const char service, const int nargs, const int nret, ofw_arg_t rets, ...);
116	extern unsigned int ofw_get_address_cells(const phandle device);	116	extern unsigned int ofw_get_address_cells(const phandle device);
117	extern unsigned int ofw_get_size_cells(const phandle device);	117	extern unsigned int ofw_get_size_cells(const phandle device);
118	extern void ofw_translate(const void virt);	118	extern void ofw_translate(const void virt);
119	extern int ofw_translate_failed(ofw_arg_t flag);	119	extern int ofw_translate_failed(ofw_arg_t flag);
120	extern void ofw_claim(const void virt, const int len);	120	extern void ofw_claim(const void virt, const int len);
121	extern int ofw_map(const void phys, const void virt, const int size, const int mode);	121	extern int ofw_map(const void phys, const void virt, const int size, const int mode);
122	extern int ofw_memmap(memmap_t *map);	122	extern int ofw_memmap(memmap_t *map);
123	extern int ofw_screen(screen_t *screen);	123	extern int ofw_screen(screen_t *screen);
124	extern int ofw_keyboard(keyboard_t *keyboard);	124	extern int ofw_keyboard(keyboard_t *keyboard);
125	extern void ofw_quiesce(void);	125	extern void ofw_quiesce(void);
126		126
127	#endif	127	#endif
128		128

Subversion Repositories HelenOS

(root)/branches/dd/boot/genarch/ofw.h @ 4704 – Rev 1947 → 2071