blob: 73f09731550236874b41c13ffbd3c631370f96ea [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
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
28#define PROM_FLAG_ARCS 1
29#define PROM_FLAG_USE_AS_CONSOLE 2
30#define PROM_FLAG_DONT_FREE_TEMP 4
31
32/* Simple char-by-char console I/O. */
33extern void prom_putchar(char c);
34extern char prom_getchar(void);
35
36/* Generic printf() using ARCS console I/O. */
37extern void prom_printf(char *fmt, ...);
38
39/* Memory descriptor management. */
40#define PROM_MAX_PMEMBLOCKS 32
41struct prom_pmemblock {
42 LONG base; /* Within KSEG0 or XKPHYS. */
43 ULONG size; /* In bytes. */
44 ULONG type; /* free or prom memory */
45};
46
47/* Get next memory descriptor after CURR, returns first descriptor
48 * in chain is CURR is NULL.
49 */
50extern struct linux_mdesc *prom_getmdesc(struct linux_mdesc *curr);
51#define PROM_NULL_MDESC ((struct linux_mdesc *) 0)
52
53/* Called by prom_init to setup the physical memory pmemblock
54 * array.
55 */
56extern void prom_meminit(void);
57extern void prom_fixup_mem_map(unsigned long start_mem, unsigned long end_mem);
58
59/* PROM device tree library routines. */
60#define PROM_NULL_COMPONENT ((pcomponent *) 0)
61
62/* Get sibling component of THIS. */
63extern pcomponent *ArcGetPeer(pcomponent *this);
64
65/* Get child component of THIS. */
66extern pcomponent *ArcGetChild(pcomponent *this);
67
68/* Get parent component of CHILD. */
69extern pcomponent *prom_getparent(pcomponent *child);
70
71/* Copy component opaque data of component THIS into BUFFER
72 * if component THIS has opaque data. Returns success or
73 * failure status.
74 */
75extern long prom_getcdata(void *buffer, pcomponent *this);
76
77/* Other misc. component routines. */
78extern pcomponent *prom_childadd(pcomponent *this, pcomponent *tmp, void *data);
79extern long prom_delcomponent(pcomponent *this);
80extern pcomponent *prom_componentbypath(char *path);
81
82/* This is called at prom_init time to identify the
83 * ARC architecture we are running on
84 */
85extern void prom_identify_arch(void);
86
87/* Environment variable routines. */
88extern PCHAR ArcGetEnvironmentVariable(PCHAR name);
89extern LONG ArcSetEnvironmentVariable(PCHAR name, PCHAR value);
90
91/* ARCS command line acquisition and parsing. */
92extern char *prom_getcmdline(void);
93extern void prom_init_cmdline(void);
94
95/* Acquiring info about the current time, etc. */
96extern struct linux_tinfo *prom_gettinfo(void);
97extern unsigned long prom_getrtime(void);
98
99/* File operations. */
100extern long prom_getvdirent(unsigned long fd, struct linux_vdirent *ent, unsigned long num, unsigned long *cnt);
101extern long prom_open(char *name, enum linux_omode md, unsigned long *fd);
102extern long prom_close(unsigned long fd);
103extern LONG ArcRead(ULONG fd, PVOID buf, ULONG num, PULONG cnt);
104extern long prom_getrstatus(unsigned long fd);
105extern LONG ArcWrite(ULONG fd, PVOID buf, ULONG num, PULONG cnt);
106extern long prom_seek(unsigned long fd, struct linux_bigint *off, enum linux_seekmode sm);
107extern long prom_mount(char *name, enum linux_mountops op);
108extern long prom_getfinfo(unsigned long fd, struct linux_finfo *buf);
109extern long prom_setfinfo(unsigned long fd, unsigned long flags, unsigned long msk);
110
111/* Running stand-along programs. */
112extern long prom_load(char *name, unsigned long end, unsigned long *pc, unsigned long *eaddr);
113extern long prom_invoke(unsigned long pc, unsigned long sp, long argc, char **argv, char **envp);
114extern long prom_exec(char *name, long argc, char **argv, char **envp);
115
116/* Misc. routines. */
117extern VOID prom_halt(VOID) __attribute__((noreturn));
118extern VOID prom_powerdown(VOID) __attribute__((noreturn));
119extern VOID prom_restart(VOID) __attribute__((noreturn));
120extern VOID ArcReboot(VOID) __attribute__((noreturn));
121extern VOID ArcEnterInteractiveMode(VOID) __attribute__((noreturn));
122extern long prom_cfgsave(VOID);
123extern struct linux_sysid *prom_getsysid(VOID);
124extern VOID ArcFlushAllCaches(VOID);
125extern DISPLAY_STATUS *ArcGetDisplayStatus(ULONG FileID);
126
127#endif /* _ASM_SGIALIB_H */