promif.h revision c9503a497f482bf9524b37eea8c69239425bcdf4
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy * CDDL HEADER START
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy * The contents of this file are subject to the terms of the
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy * Common Development and Distribution License (the "License").
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy * You may not use this file except in compliance with the License.
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy * or http://www.opensolaris.org/os/licensing.
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy * See the License for the specific language governing permissions
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy * and limitations under the License.
1d32ba663e202c24a5a1f2e5aef83fffb447cb7fJohn Wren Kennedy * When distributing Covered Code, include this CDDL HEADER in each
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
d583b39bfb4e2571d3e41097c5c357ffe353ad45John Wren Kennedy * If applicable, add the following below this CDDL HEADER, with the
1d32ba663e202c24a5a1f2e5aef83fffb447cb7fJohn Wren Kennedy * fields enclosed by brackets "[]" replaced with your own identifying
1d32ba663e202c24a5a1f2e5aef83fffb447cb7fJohn Wren Kennedy * information: Portions Copyright [yyyy] [name of copyright owner]
1d32ba663e202c24a5a1f2e5aef83fffb447cb7fJohn Wren Kennedy * CDDL HEADER END
1d32ba663e202c24a5a1f2e5aef83fffb447cb7fJohn Wren Kennedy * Copyright 2007 Sun Microsystems, Inc. All rights reserved.
1d32ba663e202c24a5a1f2e5aef83fffb447cb7fJohn Wren Kennedy * Use is subject to license terms.
1d32ba663e202c24a5a1f2e5aef83fffb447cb7fJohn Wren Kennedy#pragma ident "%Z%%M% %I% %E% SMI"
1d32ba663e202c24a5a1f2e5aef83fffb447cb7fJohn Wren Kennedy * These are for V0 ops only. We sometimes have to specify
1d32ba663e202c24a5a1f2e5aef83fffb447cb7fJohn Wren Kennedy * to promif which type of operation we need to perform
1d32ba663e202c24a5a1f2e5aef83fffb447cb7fJohn Wren Kennedy * and since we can't get such a property from a V0 prom, we
1d32ba663e202c24a5a1f2e5aef83fffb447cb7fJohn Wren Kennedy * sometimes just assume it. V2 and later proms do the right thing.
1d32ba663e202c24a5a1f2e5aef83fffb447cb7fJohn Wren Kennedy * Due to FCode on sun4u machines running in a pseudo-32-bit environment
1d32ba663e202c24a5a1f2e5aef83fffb447cb7fJohn Wren Kennedy * we need to enable code in several of the promif routines to ensure
1d32ba663e202c24a5a1f2e5aef83fffb447cb7fJohn Wren Kennedy * that 64-bit pointers from the kernel are not passed through the CIF
1d32ba663e202c24a5a1f2e5aef83fffb447cb7fJohn Wren Kennedy * to OpenBoot.
1d32ba663e202c24a5a1f2e5aef83fffb447cb7fJohn Wren Kennedy * Client programs defining this token need to provide two callbacks to
1d32ba663e202c24a5a1f2e5aef83fffb447cb7fJohn Wren Kennedy * allow the promif routines to allocate and free memory allocated from
1d32ba663e202c24a5a1f2e5aef83fffb447cb7fJohn Wren Kennedy * the bottom 32-bits of the 64-bit address space:
1d32ba663e202c24a5a1f2e5aef83fffb447cb7fJohn Wren Kennedy * void *promplat_alloc(size_t);
1d32ba663e202c24a5a1f2e5aef83fffb447cb7fJohn Wren Kennedy * void promplat_free(void *, size_t);
1d32ba663e202c24a5a1f2e5aef83fffb447cb7fJohn Wren Kennedy * The alloc function should guarantee that it will never return an
1d32ba663e202c24a5a1f2e5aef83fffb447cb7fJohn Wren Kennedy * invalid pointer.
1d32ba663e202c24a5a1f2e5aef83fffb447cb7fJohn Wren Kennedy#endif /* _BOOT */
1d32ba663e202c24a5a1f2e5aef83fffb447cb7fJohn Wren Kennedytypedef void promif_preprom_f(void);
1d32ba663e202c24a5a1f2e5aef83fffb447cb7fJohn Wren Kennedytypedef void promif_postprom_f(void);
1d32ba663e202c24a5a1f2e5aef83fffb447cb7fJohn Wren Kennedy * resource allocation group: OBP and IEEE 1275-1994.
1d32ba663e202c24a5a1f2e5aef83fffb447cb7fJohn Wren Kennedy * prom_alloc is platform dependent on SPARC.
1d32ba663e202c24a5a1f2e5aef83fffb447cb7fJohn Wren Kennedyextern caddr_t prom_alloc(caddr_t virthint, size_t size, uint_t align);
1d32ba663e202c24a5a1f2e5aef83fffb447cb7fJohn Wren Kennedyextern void prom_free(caddr_t virt, size_t size);
1d32ba663e202c24a5a1f2e5aef83fffb447cb7fJohn Wren Kennedy * Device tree and property group: OBP and IEEE 1275-1994.
1d32ba663e202c24a5a1f2e5aef83fffb447cb7fJohn Wren Kennedyextern pnode_t prom_childnode(pnode_t nodeid);
1d32ba663e202c24a5a1f2e5aef83fffb447cb7fJohn Wren Kennedyextern pnode_t prom_nextnode(pnode_t nodeid);
1d32ba663e202c24a5a1f2e5aef83fffb447cb7fJohn Wren Kennedyextern pnode_t prom_parentnode(pnode_t nodeid);
1d32ba663e202c24a5a1f2e5aef83fffb447cb7fJohn Wren Kennedyextern int prom_asr_list_keys(caddr_t value);
1d32ba663e202c24a5a1f2e5aef83fffb447cb7fJohn Wren Kennedyextern int prom_asr_disable(char *keystr, int keystr_len,
1d32ba663e202c24a5a1f2e5aef83fffb447cb7fJohn Wren Kennedyextern int prom_asr_enable(char *keystr, int keystr_len);
1d32ba663e202c24a5a1f2e5aef83fffb447cb7fJohn Wren Kennedyextern int prom_getproplen(pnode_t nodeid, caddr_t name);
1d32ba663e202c24a5a1f2e5aef83fffb447cb7fJohn Wren Kennedyextern int prom_getprop(pnode_t nodeid, caddr_t name,
1d32ba663e202c24a5a1f2e5aef83fffb447cb7fJohn Wren Kennedyextern caddr_t prom_nextprop(pnode_t nodeid, caddr_t previous,
1d32ba663e202c24a5a1f2e5aef83fffb447cb7fJohn Wren Kennedyextern int prom_setprop(pnode_t nodeid, caddr_t name,
1d32ba663e202c24a5a1f2e5aef83fffb447cb7fJohn Wren Kennedyextern int prom_getnode_byname(pnode_t id, char *name);
1d32ba663e202c24a5a1f2e5aef83fffb447cb7fJohn Wren Kennedyextern int prom_devicetype(pnode_t id, char *type);
1d32ba663e202c24a5a1f2e5aef83fffb447cb7fJohn Wren Kennedyextern char *prom_decode_composite_string(void *buf,
1d32ba663e202c24a5a1f2e5aef83fffb447cb7fJohn Wren Kennedy * Device tree and property group: IEEE 1275-1994 Only.
1d32ba663e202c24a5a1f2e5aef83fffb447cb7fJohn Wren Kennedyextern pnode_t prom_finddevice(char *path); /* Also on obp2.x */
1d32ba663e202c24a5a1f2e5aef83fffb447cb7fJohn Wren Kennedyextern int prom_bounded_getprop(pnode_t nodeid,
1d32ba663e202c24a5a1f2e5aef83fffb447cb7fJohn Wren Kennedy caddr_t name, caddr_t buffer, int buflen);
1d32ba663e202c24a5a1f2e5aef83fffb447cb7fJohn Wren Kennedyextern phandle_t prom_getphandle(ihandle_t i);
1d32ba663e202c24a5a1f2e5aef83fffb447cb7fJohn Wren Kennedy * Device pathnames and pathname conversion: OBP and IEEE 1275-1994.
1d32ba663e202c24a5a1f2e5aef83fffb447cb7fJohn Wren Kennedyextern int prom_devname_from_pathname(char *path, char *buffer);
1d32ba663e202c24a5a1f2e5aef83fffb447cb7fJohn Wren Kennedyextern char *prom_path_options(char *pathname);
1d32ba663e202c24a5a1f2e5aef83fffb447cb7fJohn Wren Kennedyextern char *prom_path_gettoken(char *from, char *to);
1d32ba663e202c24a5a1f2e5aef83fffb447cb7fJohn Wren Kennedyextern void prom_strip_options(char *from, char *to);
1d32ba663e202c24a5a1f2e5aef83fffb447cb7fJohn Wren Kennedy * Device pathnames and pathname conversion: IEEE 1275-1994 only.
1d32ba663e202c24a5a1f2e5aef83fffb447cb7fJohn Wren Kennedyextern int prom_ihandle_to_path(ihandle_t, char *buf,
1d32ba663e202c24a5a1f2e5aef83fffb447cb7fJohn Wren Kennedyextern int prom_phandle_to_path(phandle_t, char *buf,
1d32ba663e202c24a5a1f2e5aef83fffb447cb7fJohn Wren Kennedy * Special device nodes: OBP and IEEE 1275-1994.
1d32ba663e202c24a5a1f2e5aef83fffb447cb7fJohn Wren Kennedyextern ihandle_t prom_stdout_ihandle(void);
1d32ba663e202c24a5a1f2e5aef83fffb447cb7fJohn Wren Kennedyextern char *prom_stdinpath(void);
1d32ba663e202c24a5a1f2e5aef83fffb447cb7fJohn Wren Kennedyextern char *prom_stdoutpath(void);
1d32ba663e202c24a5a1f2e5aef83fffb447cb7fJohn Wren Kennedyextern int prom_stdin_devname(char *buffer);
1d32ba663e202c24a5a1f2e5aef83fffb447cb7fJohn Wren Kennedyextern int prom_stdout_devname(char *buffer);
1d32ba663e202c24a5a1f2e5aef83fffb447cb7fJohn Wren Kennedyextern int prom_stdout_is_framebuffer(void);
1d32ba663e202c24a5a1f2e5aef83fffb447cb7fJohn Wren Kennedyextern void prom_get_tem_inverses(int *, int *);
1d32ba663e202c24a5a1f2e5aef83fffb447cb7fJohn Wren Kennedyextern void prom_get_tem_size(size_t *, size_t *);
1d32ba663e202c24a5a1f2e5aef83fffb447cb7fJohn Wren Kennedyextern void prom_get_tem_pos(uint32_t *, uint32_t *);
1d32ba663e202c24a5a1f2e5aef83fffb447cb7fJohn Wren Kennedyextern void prom_get_term_font_size(int *, int *);
1d32ba663e202c24a5a1f2e5aef83fffb447cb7fJohn Wren Kennedyextern void prom_hide_cursor(void);
1d32ba663e202c24a5a1f2e5aef83fffb447cb7fJohn Wren Kennedy * Special device nodes: IEEE 1275-1994 only.
1d32ba663e202c24a5a1f2e5aef83fffb447cb7fJohn Wren Kennedyextern ihandle_t prom_memory_ihandle(void);
1d32ba663e202c24a5a1f2e5aef83fffb447cb7fJohn Wren Kennedy * Administrative group: OBP and IEEE 1275-1994.
1d32ba663e202c24a5a1f2e5aef83fffb447cb7fJohn Wren Kennedyextern void prom_enter_mon(void);
1d32ba663e202c24a5a1f2e5aef83fffb447cb7fJohn Wren Kennedyextern int prom_getversion(void);
1d32ba663e202c24a5a1f2e5aef83fffb447cb7fJohn Wren Kennedyextern int prom_is_p1275(void);
extern char *prom_bootpath(void);
extern char *prom_bootargs(void);
extern void prom_suspend_prepost(void);
extern void prom_resume_prepost(void);
extern void (*prom_set_nextprop_preprom(void (*)(void)))(void);
extern void (*prom_set_nextprop_postprom(void (*)(void)))(void);
extern void prom_putchar(char c);
extern int prom_mayget(void);
extern int prom_mayput(char c);
int (*f)(pnode_t, void *, void *),
#define PROM_STOP { \
prom_enter_mon(); \
#ifdef _KERNEL
* in prom_env.c and in sunpm.c
typedef struct promif_owrap {
void (*preout)(void);
void (*postout)(void);
int *status);
int *status);
#ifdef __cplusplus