1/* 2 * This file is subject to the terms and conditions of the GNU General Public 3 * License. See the file "COPYING" in the main directory of this archive 4 * for more details. 5 * 6 * SGI ARCS firmware interface library for the Linux kernel. 7 * 8 * Copyright (C) 1996 David S. Miller (dm@engr.sgi.com) 9 * Copyright (C) 2001, 2002 Ralf Baechle (ralf@gnu.org) 10 */ 11#ifndef _ASM_SGIALIB_H 12#define _ASM_SGIALIB_H 13 14#include <asm/sgiarcs.h> 15 16extern struct linux_romvec *romvec; 17extern int prom_argc; 18 19extern LONG *_prom_argv, *_prom_envp; 20 21/* A 32-bit ARC PROM pass arguments and environment as 32-bit pointer. 22 These macros take care of sign extension. */ 23#define prom_argv(index) ((char *) (long) _prom_argv[(index)]) 24#define prom_argc(index) ((char *) (long) _prom_argc[(index)]) 25 26extern int prom_flags; 27#define PROM_FLAG_ARCS 1 28#define PROM_FLAG_USE_AS_CONSOLE 2 29 30/* Init the PROM library and it's internal data structures. */ 31extern void prom_init(int argc, char **argv, char **envp, int *prom_vec); 32 33/* Simple char-by-char console I/O. */ 34extern void prom_putchar(char c); 35extern char prom_getchar(void); 36 37/* Generic printf() using ARCS console I/O. */ 38extern void prom_printf(char *fmt, ...); 39 40/* Memory descriptor management. */ 41#define PROM_MAX_PMEMBLOCKS 32 42struct prom_pmemblock { 43 LONG base; /* Within KSEG0 or XKPHYS. */ 44 ULONG size; /* In bytes. */ 45 ULONG type; /* free or prom memory */ 46}; 47 48/* Get next memory descriptor after CURR, returns first descriptor 49 * in chain is CURR is NULL. 50 */ 51extern struct linux_mdesc *prom_getmdesc(struct linux_mdesc *curr); 52#define PROM_NULL_MDESC ((struct linux_mdesc *) 0) 53 54/* Called by prom_init to setup the physical memory pmemblock 55 * array. 56 */ 57extern void prom_meminit(void); 58extern void prom_fixup_mem_map(unsigned long start_mem, unsigned long end_mem); 59 60/* PROM device tree library routines. */ 61#define PROM_NULL_COMPONENT ((pcomponent *) 0) 62 63/* Get sibling component of THIS. */ 64extern pcomponent *ArcGetPeer(pcomponent *this); 65 66/* Get child component of THIS. */ 67extern pcomponent *ArcGetChild(pcomponent *this); 68 69/* Get parent component of CHILD. */ 70extern pcomponent *prom_getparent(pcomponent *child); 71 72/* Copy component opaque data of component THIS into BUFFER 73 * if component THIS has opaque data. Returns success or 74 * failure status. 75 */ 76extern long prom_getcdata(void *buffer, pcomponent *this); 77 78/* Other misc. component routines. */ 79extern pcomponent *prom_childadd(pcomponent *this, pcomponent *tmp, void *data); 80extern long prom_delcomponent(pcomponent *this); 81extern pcomponent *prom_componentbypath(char *path); 82 83/* This is called at prom_init time to identify the 84 * ARC architecture we are running on 85 */ 86extern void prom_identify_arch(void); 87 88/* Environment variable routines. */ 89extern PCHAR ArcGetEnvironmentVariable(PCHAR name); 90extern LONG ArcSetEnvironmentVariable(PCHAR name, PCHAR value); 91 92/* ARCS command line acquisition and parsing. */ 93extern char *prom_getcmdline(void); 94extern void prom_init_cmdline(void); 95 96/* Acquiring info about the current time, etc. */ 97extern struct linux_tinfo *prom_gettinfo(void); 98extern unsigned long prom_getrtime(void); 99 100/* File operations. */ 101extern long prom_getvdirent(unsigned long fd, struct linux_vdirent *ent, unsigned long num, unsigned long *cnt); 102extern long prom_open(char *name, enum linux_omode md, unsigned long *fd); 103extern long prom_close(unsigned long fd); 104extern LONG ArcRead(ULONG fd, PVOID buf, ULONG num, PULONG cnt); 105extern long prom_getrstatus(unsigned long fd); 106extern LONG ArcWrite(ULONG fd, PVOID buf, ULONG num, PULONG cnt); 107extern long prom_seek(unsigned long fd, struct linux_bigint *off, enum linux_seekmode sm); 108extern long prom_mount(char *name, enum linux_mountops op); 109extern long prom_getfinfo(unsigned long fd, struct linux_finfo *buf); 110extern long prom_setfinfo(unsigned long fd, unsigned long flags, unsigned long msk); 111 112/* Running stand-along programs. */ 113extern long prom_load(char *name, unsigned long end, unsigned long *pc, unsigned long *eaddr); 114extern long prom_invoke(unsigned long pc, unsigned long sp, long argc, char **argv, char **envp); 115extern long prom_exec(char *name, long argc, char **argv, char **envp); 116 117/* Misc. routines. */ 118extern VOID prom_halt(VOID) __attribute__((noreturn)); 119extern VOID prom_powerdown(VOID) __attribute__((noreturn)); 120extern VOID prom_restart(VOID) __attribute__((noreturn)); 121extern VOID ArcReboot(VOID) __attribute__((noreturn)); 122extern VOID ArcEnterInteractiveMode(VOID) __attribute__((noreturn)); 123extern long prom_cfgsave(VOID); 124extern struct linux_sysid *prom_getsysid(VOID); 125extern VOID ArcFlushAllCaches(VOID); 126 127#endif /* _ASM_SGIALIB_H */ 128