[apple/bootx.git] / bootx.tproj / include.subproj / ci.h

/*
 * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
 *
 * @APPLE_LICENSE_HEADER_START@
 * 
 * The contents of this file constitute Original Code as defined in and
 * are subject to the Apple Public Source License Version 1.1 (the
 * "License").  You may not use this file except in compliance with the
 * License.  Please obtain a copy of the License at
 * http://www.apple.com/publicsource and read it before using this file.
 * 
 * This Original Code and all software distributed under the License are
 * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT.  Please see the
 * License for the specific language governing rights and limitations
 * under the License.
 * 
 * @APPLE_LICENSE_HEADER_END@
 */
/*
 *  ci.h - Headers for the OF Client Interface Library
 *
 *  Copyright (c) 1998-2002 Apple Computer, Inc.
 *
 *  DRI: Josh de Cesare
 */

#ifndef _BOOTX_CI_H_
#define _BOOTX_CI_H_

#define kCINoError (0)
#define kCIError   (-1)
#define kCICatch   (-2)

typedef long CICell;

struct CIArgs {
  char *service;
  CICell nArgs;
  CICell nReturns;
  
  union {
    struct {			// nArgs=1 + args, nReturns=1 + rets
      const char *forth;
      CICell     cells[6 + 1 + 6];
    } interpret;
    
    struct {			// nArgs=2 + args, nReturns=1 + rets
      const char *method;
      CICell     iHandle;
      CICell     cells[6 + 1 + 6];
    } callMethod;
    
    struct {			// nArgs=1, nReturns=1	( device-specifier -- ihandle )
      char *devSpec;	        // IN parameter
      CICell ihandle;		// RETURN value
    } open;
    
    struct {			// nArgs=1, nReturns=0	( ihandle -- )
      CICell ihandle;		// IN parameter
    } close;
    
    struct {                    // nArgs=3, nReturns=1 ( ihandle addr length -- actual )
      CICell ihandle;
      CICell addr;
      CICell length;
      CICell actual;
    } read;
    
    struct {                    // nArgs=3, nReturns=1 ( ihandle addr length -- actual )
      CICell ihandle;
      CICell addr;
      CICell length;
      CICell actual;
    } write;
    
    struct {                    // nArgs=3, nReturns=1 ( ihandle pos.high pos.low -- result )
      CICell ihandle;
      CICell pos_high;
      CICell pos_low;
      CICell result;
    } seek;
    
    struct {			// nArgs=3, nReturns=1
      CICell virt;
      CICell size;
      CICell align;
      CICell baseaddr;
    } claim;
    
    struct {			// nArgs=2, nReturns=0
      CICell virt;
      CICell size;
    } release;
    
    struct {			// nArgs=1, nReturns=1	( phandle -- peer-phandle )
      CICell phandle;	        // IN parameter
      CICell peerPhandle;	// RETURN value
    } peer;
    
    struct {			// nArgs=1, nReturns=1	( phandle -- child-phandle )
      CICell phandle;		// IN parameter
      CICell childPhandle;	// RETURN value
    } child;
    
    struct {			// nArgs=1, nReturns=1	( phandle -- parent-phandle )
      CICell childPhandle;	// IN parameter
      CICell parentPhandle;	// RETURN value
    } parent;
    
    struct {			// nArgs=1, nReturns=1	( devSpec -- phandle )
      char *devSpec;	        // IN parameter
      CICell phandle;	        // RETURN value
    } finddevice;
    
    struct {                    // nArgs=3, nReturns=1 ( ihandle buf buflen -- length )
      CICell ihandle;           // IN ihandle
      char   *buf;              // IN buf
      CICell buflen;            // IN buflen
      CICell length;            // RETURN length
    } instanceToPath;
    
    struct {                    // nArgs=1, nReturns=1 ( ihandle -- phandle )
      CICell ihandle;           // IN ihandle
      CICell phandle;           // RETURN phandle
    } instanceToPackage;
    
    struct {                    // nArgs=3, nReturns=1 ( phandle buf buflen -- length )
      CICell phandle;           // IN phandle
      char   *buf;              // IN buf
      CICell buflen;            // IN buflen
      CICell length;            // RETURN length
    } packageToPath;
    
    struct {			// nArgs=2, nReturns=1	( phandle name -- size )
      CICell phandle;		// IN parameter
      char   *name;		// IN parameter
      CICell size;		// RETURN value
    } getproplen;
    
    struct {			// nArgs=4, nReturns=1	( phandle name buf buflen -- size )
      CICell phandle;		// IN parameter
      char   *name;		// IN parameter
      char   *buf;		// IN parameter
      CICell buflen;		// IN parameter
      CICell size;		// RETURN value
    } getprop;
    
    struct {			// nArgs=3, nReturns=1	( phandle previous buf -- flag )
      CICell phandle;		// IN parameter
      char *previous;		// IN parameter
      char *buf;		// IN parameter
      CICell flag;		// RETURN value
    } nextprop;
    
    struct {			// nArgs=4, nReturns=1	( phandle name buf buflen -- size )
      CICell phandle;		// IN parameter
      char *name;		// IN parameter
      char *buf;		// IN parameter
      CICell buflen;		// IN parameter
      CICell size;		// RETURN value
    } setprop;
    
    struct {			// nArgs=1, nReturns=0
      char *bootspec;
    } boot;
  } args;
};
typedef struct CIArgs CIArgs;

typedef long (*ClientInterfacePtr)(CIArgs *args);

// ci.c
long InitCI(ClientInterfacePtr ciPtr);
long CallCI(CIArgs *ciArgsPtr);

// Device Tree
CICell Peer(CICell phandle);
CICell Child(CICell phandle);
CICell Parent(CICell phandle);
CICell FindDevice(char *devSpec);
CICell InstanceToPath(CICell ihandle, char *buf, long buflen);
CICell InstanceToPackage(CICell ihandle);
CICell PackageToPath(CICell phandle, char *buf, long buflen);
CICell GetPropLen(CICell phandle, char *name);
CICell GetProp(CICell phandle, char *name, char *buf, long buflen);
CICell NextProp(CICell phandle, char *previous, char *buf);
CICell SetProp(CICell phandle, char *name, char *buf, long buflen);

// Device I/O
CICell Open(char *devSpec);
void   Close(CICell ihandle);
CICell Read(CICell ihandle, long addr, long length);
CICell Write(CICell ihandle, long addr, long length);
CICell Seek(CICell ihandle, long long position);

// Call Method
long CallMethod(long args, long rets, CICell iHandle, const char *method, ...);

// Memory
CICell Claim(CICell virt, CICell size, CICell align);
void   Release(CICell virt, CICell size);

// Control Transfer
void Boot(char *bootspec);
void Enter(void);
void Exit(void);
void Quiesce(void);

// Interpret
long Interpret(long args, long rets, const char *forthString, ...);

#endif /* ! _BOOTX_CI_H_ */
Commit	Line	Data
04fee52e A	1	/*
	2	* Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
	3	*
	4	* @APPLE_LICENSE_HEADER_START@
	5	*
	6	* The contents of this file constitute Original Code as defined in and
	7	* are subject to the Apple Public Source License Version 1.1 (the
	8	* "License"). You may not use this file except in compliance with the
	9	* License. Please obtain a copy of the License at
	10	* http://www.apple.com/publicsource and read it before using this file.
	11	*
	12	* This Original Code and all software distributed under the License are
	13	* distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
	14	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
	15	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
	16	* FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT. Please see the
	17	* License for the specific language governing rights and limitations
	18	* under the License.
	19	*
	20	* @APPLE_LICENSE_HEADER_END@
	21	*/
	22	/*
	23	* ci.h - Headers for the OF Client Interface Library
	24	*
366defd1	25	* Copyright (c) 1998-2002 Apple Computer, Inc.
04fee52e A	26	*
	27	* DRI: Josh de Cesare
	28	*/
	29
	30	#ifndef _BOOTX_CI_H_
	31	#define _BOOTX_CI_H_
	32
	33	#define kCINoError (0)
	34	#define kCIError (-1)
	35	#define kCICatch (-2)
	36
	37	typedef long CICell;
	38
	39	struct CIArgs {
	40	char *service;
	41	CICell nArgs;
	42	CICell nReturns;
	43
	44	union {
366defd1 A	45	struct { // nArgs=1 + args, nReturns=1 + rets
	46	const char *forth;
	47	CICell cells[6 + 1 + 6];
	48	} interpret;
	49
	50	struct { // nArgs=2 + args, nReturns=1 + rets
	51	const char *method;
	52	CICell iHandle;
	53	CICell cells[6 + 1 + 6];
	54	} callMethod;
	55
04fee52e A	56	struct { // nArgs=1, nReturns=1 ( device-specifier -- ihandle )
	57	char *devSpec; // IN parameter
	58	CICell ihandle; // RETURN value
	59	} open;
366defd1	60
04fee52e A	61	struct { // nArgs=1, nReturns=0 ( ihandle -- )
	62	CICell ihandle; // IN parameter
	63	} close;
366defd1	64
04fee52e A	65	struct { // nArgs=3, nReturns=1 ( ihandle addr length -- actual )
	66	CICell ihandle;
	67	CICell addr;
	68	CICell length;
	69	CICell actual;
	70	} read;
	71
	72	struct { // nArgs=3, nReturns=1 ( ihandle addr length -- actual )
	73	CICell ihandle;
	74	CICell addr;
	75	CICell length;
	76	CICell actual;
	77	} write;
	78
	79	struct { // nArgs=3, nReturns=1 ( ihandle pos.high pos.low -- result )
	80	CICell ihandle;
	81	CICell pos_high;
	82	CICell pos_low;
	83	CICell result;
	84	} seek;
	85
	86	struct { // nArgs=3, nReturns=1
	87	CICell virt;
	88	CICell size;
	89	CICell align;
	90	CICell baseaddr;
	91	} claim;
	92
	93	struct { // nArgs=2, nReturns=0
	94	CICell virt;
	95	CICell size;
	96	} release;
	97
	98	struct { // nArgs=1, nReturns=1 ( phandle -- peer-phandle )
	99	CICell phandle; // IN parameter
	100	CICell peerPhandle; // RETURN value
	101	} peer;
	102
	103	struct { // nArgs=1, nReturns=1 ( phandle -- child-phandle )
	104	CICell phandle; // IN parameter
	105	CICell childPhandle; // RETURN value
	106	} child;
	107
	108	struct { // nArgs=1, nReturns=1 ( phandle -- parent-phandle )
	109	CICell childPhandle; // IN parameter
	110	CICell parentPhandle; // RETURN value
	111	} parent;
	112
	113	struct { // nArgs=1, nReturns=1 ( devSpec -- phandle )
	114	char *devSpec; // IN parameter
	115	CICell phandle; // RETURN value
	116	} finddevice;
	117
	118	struct { // nArgs=3, nReturns=1 ( ihandle buf buflen -- length )
	119	CICell ihandle; // IN ihandle
	120	char *buf; // IN buf
	121	CICell buflen; // IN buflen
	122	CICell length; // RETURN length
	123	} instanceToPath;
	124
	125	struct { // nArgs=1, nReturns=1 ( ihandle -- phandle )
	126	CICell ihandle; // IN ihandle
	127	CICell phandle; // RETURN phandle
	128	} instanceToPackage;
129
130	struct { // nArgs=3, nReturns=1 ( phandle buf buflen -- length )
131	CICell phandle; // IN phandle
132	char *buf; // IN buf
133	CICell buflen; // IN buflen
134	CICell length; // RETURN length
135	} packageToPath;
136
137	struct { // nArgs=2, nReturns=1 ( phandle name -- size )
138	CICell phandle; // IN parameter
139	char *name; // IN parameter
140	CICell size; // RETURN value
141	} getproplen;
142
143	struct { // nArgs=4, nReturns=1 ( phandle name buf buflen -- size )
144	CICell phandle; // IN parameter
145	char *name; // IN parameter
146	char *buf; // IN parameter
147	CICell buflen; // IN parameter
148	CICell size; // RETURN value
149	} getprop;
150
151	struct { // nArgs=3, nReturns=1 ( phandle previous buf -- flag )
152	CICell phandle; // IN parameter
153	char *previous; // IN parameter
154	char *buf; // IN parameter
155	CICell flag; // RETURN value
156	} nextprop;
157
158	struct { // nArgs=4, nReturns=1 ( phandle name buf buflen -- size )
159	CICell phandle; // IN parameter
160	char *name; // IN parameter
161	char *buf; // IN parameter
162	CICell buflen; // IN parameter
163	CICell size; // RETURN value
164	} setprop;
165
166	struct { // nArgs=1, nReturns=0
167	char *bootspec;
168	} boot;
169	} args;
170	};
171	typedef struct CIArgs CIArgs;
172
173	typedef long (ClientInterfacePtr)(CIArgs args);
174
175	// ci.c
176	long InitCI(ClientInterfacePtr ciPtr);
04fee52e A	177	long CallCI(CIArgs *ciArgsPtr);
	178
	179	// Device Tree
	180	CICell Peer(CICell phandle);
	181	CICell Child(CICell phandle);
	182	CICell Parent(CICell phandle);
	183	CICell FindDevice(char *devSpec);
	184	CICell InstanceToPath(CICell ihandle, char *buf, long buflen);
	185	CICell InstanceToPackage(CICell ihandle);
	186	CICell PackageToPath(CICell phandle, char *buf, long buflen);
	187	CICell GetPropLen(CICell phandle, char *name);
	188	CICell GetProp(CICell phandle, char name, char buf, long buflen);
	189	CICell NextProp(CICell phandle, char previous, char buf);
	190	CICell SetProp(CICell phandle, char name, char buf, long buflen);
	191
	192	// Device I/O
	193	CICell Open(char *devSpec);
	194	void Close(CICell ihandle);
	195	CICell Read(CICell ihandle, long addr, long length);
	196	CICell Write(CICell ihandle, long addr, long length);
	197	CICell Seek(CICell ihandle, long long position);
	198
	199	// Call Method
366defd1	200	long CallMethod(long args, long rets, CICell iHandle, const char *method, ...);
04fee52e A	201
	202	// Memory
	203	CICell Claim(CICell virt, CICell size, CICell align);
	204	void Release(CICell virt, CICell size);
	205
	206	// Control Transfer
	207	void Boot(char *bootspec);
	208	void Enter(void);
	209	void Exit(void);
	210	void Quiesce(void);
	211
366defd1 A	212	// Interpret
366defd1 A	213	long Interpret(long args, long rets, const char *forthString, ...);
04fee52e A	214
04fee52e A	215	#endif /* ! _BOOTX_CI_H_ */