src/include/of.h

#ifndef OF_H
#define OF_H

/*
 *  Copyright (C) 2005-2007  Anders Gavare.  All rights reserved.
 *
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions are met:
 *
 *  1. Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 *  2. 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.
 *  3. 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 AND CONTRIBUTORS ``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 OR CONTRIBUTORS 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.
 *
 *  $Id: of.h,v 1.8 2006/12/30 13:31:01 debug Exp $
 *
 *  OpenFirmware emulation. (See src/promemul/of.c for details.)
 */

struct machine;
struct cpu;
struct vfb_data;

#ifdef OF_C

#define OF_N_MAX_ARGS           10
#define OF_ARG_MAX_LEN          4096

struct of_device_property {
        struct of_device_property *next;
        char                    *name;

        unsigned char           *data;
        uint32_t                len;
        int                     flags;
};

#define OF_PROP_STRING          1
#define OF_PROP_INT             2

struct of_device {
        struct of_device        *next;
        int                     handle;
        int                     parent;
        char                    *name;
        struct of_device_property *properties;
};

#define OF_FIND(ptr,cond)       for (; ptr != NULL; ptr = ptr->next)    \
                                        if (cond)                       \
                                                break;

#define OF_SERVICE_ARGS         struct cpu *, char **, uint64_t, uint64_t

/*
 *  OpenFirmare service 'name' is defined by a OF_SERVICE(name). The code
 *  implementing the service should use OF_GET_ARG to read numerical arguments
 *  and use arg[] for strings.
 */
#define OF_SERVICE(n)           static int of__ ## n (struct cpu *cpu, \
                                char **arg, uint64_t base, uint64_t retofs)
#define OF_GET_ARG(i)           load_32bit_word(cpu, base + 12 + \
                                sizeof(uint32_t) * (i))

struct of_service {
        struct of_service       *next;
        char                    *name;
        int                     (*f)(OF_SERVICE_ARGS);
        int                     n_args;
        int                     n_ret_args;
};

struct of_data {
        struct of_device        *of_devices;
        struct of_service       *of_services;

        /*  For framebuffers:  */
        struct vfb_data         *vfb_data;
};

#endif  /*  OF_C  */


struct of_data *of_emul_init(struct machine *machine, struct vfb_data *,
        uint64_t fb_addr, int fb_xsize, int fb_ysize);

void of_emul_init_uninorth(struct machine *);
void of_emul_init_isa(struct machine *);
void of_emul_init_adb(struct machine *);
void of_emul_init_zs(struct machine *);

int of_emul(struct cpu *cpu);


#endif  /*  OF_H  */
1	dpavlin	22	#ifndef OF_H
2			#define OF_H
3
4			/*
5	dpavlin	34	* Copyright (C) 2005-2007 Anders Gavare. All rights reserved.
6	dpavlin	22	*
7			* Redistribution and use in source and binary forms, with or without
8			* modification, are permitted provided that the following conditions are met:
9			*
10			* 1. Redistributions of source code must retain the above copyright
11			* notice, this list of conditions and the following disclaimer.
12			* 2. Redistributions in binary form must reproduce the above copyright
13			* notice, this list of conditions and the following disclaimer in the
14			* documentation and/or other materials provided with the distribution.
15			* 3. The name of the author may not be used to endorse or promote products
16			* derived from this software without specific prior written permission.
17			*
18			* THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
19			* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20			* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21			* ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
22			* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23			* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24			* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25			* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26			* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27			* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28			* SUCH DAMAGE.
29			*
30	dpavlin	34	* $Id: of.h,v 1.8 2006/12/30 13:31:01 debug Exp $
31	dpavlin	22	*
32			* OpenFirmware emulation. (See src/promemul/of.c for details.)
33			*/
34
35			struct machine;
36			struct cpu;
37			struct vfb_data;
38
39			#ifdef OF_C
40
41			#define OF_N_MAX_ARGS 10
42			#define OF_ARG_MAX_LEN 4096
43
44			struct of_device_property {
45			struct of_device_property *next;
46			char *name;
47
48			unsigned char *data;
49			uint32_t len;
50			int flags;
51			};
52
53			#define OF_PROP_STRING 1
54			#define OF_PROP_INT 2
55
56			struct of_device {
57			struct of_device *next;
58			int handle;
59			int parent;
60			char *name;
61			struct of_device_property *properties;
62			};
63
64			#define OF_FIND(ptr,cond) for (; ptr != NULL; ptr = ptr->next) \
65			if (cond) \
66			break;
67
68			#define OF_SERVICE_ARGS struct cpu , char *, uint64_t, uint64_t
69
70			/*
71			* OpenFirmare service 'name' is defined by a OF_SERVICE(name). The code
72			* implementing the service should use OF_GET_ARG to read numerical arguments
73			* and use arg[] for strings.
74			*/
75			#define OF_SERVICE(n) static int of__ ## n (struct cpu *cpu, \
76			char **arg, uint64_t base, uint64_t retofs)
77			#define OF_GET_ARG(i) load_32bit_word(cpu, base + 12 + \
78			sizeof(uint32_t) * (i))
79
80			struct of_service {
81			struct of_service *next;
82			char *name;
83			int (*f)(OF_SERVICE_ARGS);
84			int n_args;
85			int n_ret_args;
86			};
87
88			struct of_data {
89			struct of_device *of_devices;
90			struct of_service *of_services;
91
92			/* For framebuffers: */
93			struct vfb_data *vfb_data;
94			};
95
96			#endif /* OF_C */
97
98
99			struct of_data of_emul_init(struct machine machine, struct vfb_data *,
100			uint64_t fb_addr, int fb_xsize, int fb_ysize);
101
102			void of_emul_init_uninorth(struct machine *);
103			void of_emul_init_isa(struct machine *);
104			void of_emul_init_adb(struct machine *);
105			void of_emul_init_zs(struct machine *);
106
107			int of_emul(struct cpu *cpu);
108
109
110			#endif /* OF_H */