tjh.dev
Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
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 * ARC firmware interface defines.
7 *
8 * Copyright (C) 1996 David S. Miller (dm@engr.sgi.com)
9 * Copyright (C) 1999, 2001 Ralf Baechle (ralf@gnu.org)
10 * Copyright (C) 1999 Silicon Graphics, Inc.
11 */
12#ifndef _ASM_SGIARCS_H
13#define _ASM_SGIARCS_H
14
15#include <linux/config.h>
16#include <asm/types.h>
17#include <asm/arc/types.h>
18
19/* Various ARCS error codes. */
20#define PROM_ESUCCESS 0x00
21#define PROM_E2BIG 0x01
22#define PROM_EACCESS 0x02
23#define PROM_EAGAIN 0x03
24#define PROM_EBADF 0x04
25#define PROM_EBUSY 0x05
26#define PROM_EFAULT 0x06
27#define PROM_EINVAL 0x07
28#define PROM_EIO 0x08
29#define PROM_EISDIR 0x09
30#define PROM_EMFILE 0x0a
31#define PROM_EMLINK 0x0b
32#define PROM_ENAMETOOLONG 0x0c
33#define PROM_ENODEV 0x0d
34#define PROM_ENOENT 0x0e
35#define PROM_ENOEXEC 0x0f
36#define PROM_ENOMEM 0x10
37#define PROM_ENOSPC 0x11
38#define PROM_ENOTDIR 0x12
39#define PROM_ENOTTY 0x13
40#define PROM_ENXIO 0x14
41#define PROM_EROFS 0x15
42/* SGI ARCS specific errno's. */
43#define PROM_EADDRNOTAVAIL 0x1f
44#define PROM_ETIMEDOUT 0x20
45#define PROM_ECONNABORTED 0x21
46#define PROM_ENOCONNECT 0x22
47
48/* Device classes, types, and identifiers for prom
49 * device inventory queries.
50 */
51enum linux_devclass {
52 system, processor, cache, adapter, controller, peripheral, memory
53};
54
55enum linux_devtypes {
56 /* Generic stuff. */
57 Arc, Cpu, Fpu,
58
59 /* Primary insn and data caches. */
60 picache, pdcache,
61
62 /* Secondary insn, data, and combined caches. */
63 sicache, sdcache, sccache,
64
65 memdev, eisa_adapter, tc_adapter, scsi_adapter, dti_adapter,
66 multifunc_adapter, dsk_controller, tp_controller, cdrom_controller,
67 worm_controller, serial_controller, net_controller, disp_controller,
68 parallel_controller, ptr_controller, kbd_controller, audio_controller,
69 misc_controller, disk_peripheral, flpy_peripheral, tp_peripheral,
70 modem_peripheral, monitor_peripheral, printer_peripheral,
71 ptr_peripheral, kbd_peripheral, term_peripheral, line_peripheral,
72 net_peripheral, misc_peripheral, anon
73};
74
75enum linux_identifier {
76 bogus, ronly, removable, consin, consout, input, output
77};
78
79/* A prom device tree component. */
80struct linux_component {
81 enum linux_devclass class; /* node class */
82 enum linux_devtypes type; /* node type */
83 enum linux_identifier iflags; /* node flags */
84 USHORT vers; /* node version */
85 USHORT rev; /* node revision */
86 ULONG key; /* completely magic */
87 ULONG amask; /* XXX affinity mask??? */
88 ULONG cdsize; /* size of configuration data */
89 ULONG ilen; /* length of string identifier */
90 _PULONG iname; /* string identifier */
91};
92typedef struct linux_component pcomponent;
93
94struct linux_sysid {
95 char vend[8], prod[8];
96};
97
98/* ARCS prom memory descriptors. */
99enum arcs_memtypes {
100 arcs_eblock, /* exception block */
101 arcs_rvpage, /* ARCS romvec page */
102 arcs_fcontig, /* Contiguous and free */
103 arcs_free, /* Generic free memory */
104 arcs_bmem, /* Borken memory, don't use */
105 arcs_prog, /* A loaded program resides here */
106 arcs_atmp, /* ARCS temporary storage area, wish Sparc OpenBoot told this */
107 arcs_aperm, /* ARCS permanent storage... */
108};
109
110/* ARC has slightly different types than ARCS */
111enum arc_memtypes {
112 arc_eblock, /* exception block */
113 arc_rvpage, /* romvec page */
114 arc_free, /* Generic free memory */
115 arc_bmem, /* Borken memory, don't use */
116 arc_prog, /* A loaded program resides here */
117 arc_atmp, /* temporary storage area */
118 arc_aperm, /* permanent storage */
119 arc_fcontig, /* Contiguous and free */
120};
121
122union linux_memtypes {
123 enum arcs_memtypes arcs;
124 enum arc_memtypes arc;
125};
126
127struct linux_mdesc {
128 union linux_memtypes type;
129 ULONG base;
130 ULONG pages;
131};
132
133/* Time of day descriptor. */
134struct linux_tinfo {
135 unsigned short yr;
136 unsigned short mnth;
137 unsigned short day;
138 unsigned short hr;
139 unsigned short min;
140 unsigned short sec;
141 unsigned short msec;
142};
143
144/* ARCS virtual dirents. */
145struct linux_vdirent {
146 ULONG namelen;
147 unsigned char attr;
148 char fname[32]; /* XXX imperical, should be a define */
149};
150
151/* Other stuff for files. */
152enum linux_omode {
153 rdonly, wronly, rdwr, wronly_creat, rdwr_creat,
154 wronly_ssede, rdwr_ssede, dirent, dirent_creat
155};
156
157enum linux_seekmode {
158 absolute, relative
159};
160
161enum linux_mountops {
162 media_load, media_unload
163};
164
165/* This prom has a bolixed design. */
166struct linux_bigint {
167#ifdef __MIPSEL__
168 u32 lo;
169 s32 hi;
170#else /* !(__MIPSEL__) */
171 s32 hi;
172 u32 lo;
173#endif
174};
175
176struct linux_finfo {
177 struct linux_bigint begin;
178 struct linux_bigint end;
179 struct linux_bigint cur;
180 enum linux_devtypes dtype;
181 unsigned long namelen;
182 unsigned char attr;
183 char name[32]; /* XXX imperical, should be define */
184};
185
186/* This describes the vector containing function pointers to the ARC
187 firmware functions. */
188struct linux_romvec {
189 LONG load; /* Load an executable image. */
190 LONG invoke; /* Invoke a standalong image. */
191 LONG exec; /* Load and begin execution of a
192 standalone image. */
193 LONG halt; /* Halt the machine. */
194 LONG pdown; /* Power down the machine. */
195 LONG restart; /* XXX soft reset??? */
196 LONG reboot; /* Reboot the machine. */
197 LONG imode; /* Enter PROM interactive mode. */
198 LONG _unused1; /* Was ReturnFromMain(). */
199
200 /* PROM device tree interface. */
201 LONG next_component;
202 LONG child_component;
203 LONG parent_component;
204 LONG component_data;
205 LONG child_add;
206 LONG comp_del;
207 LONG component_by_path;
208
209 /* Misc. stuff. */
210 LONG cfg_save;
211 LONG get_sysid;
212
213 /* Probing for memory. */
214 LONG get_mdesc;
215 LONG _unused2; /* was Signal() */
216
217 LONG get_tinfo;
218 LONG get_rtime;
219
220 /* File type operations. */
221 LONG get_vdirent;
222 LONG open;
223 LONG close;
224 LONG read;
225 LONG get_rstatus;
226 LONG write;
227 LONG seek;
228 LONG mount;
229
230 /* Dealing with firmware environment variables. */
231 LONG get_evar;
232 LONG set_evar;
233
234 LONG get_finfo;
235 LONG set_finfo;
236
237 /* Miscellaneous. */
238 LONG cache_flush;
239 LONG TestUnicodeCharacter; /* ARC; not sure if ARCS too */
240 LONG GetDisplayStatus;
241};
242
243/* The SGI ARCS parameter block is in a fixed location for standalone
244 * programs to access PROM facilities easily.
245 */
246typedef struct _SYSTEM_PARAMETER_BLOCK {
247 ULONG magic; /* magic cookie */
248#define PROMBLOCK_MAGIC 0x53435241
249
250 ULONG len; /* length of parm block */
251 USHORT ver; /* ARCS firmware version */
252 USHORT rev; /* ARCS firmware revision */
253 _PLONG rs_block; /* Restart block. */
254 _PLONG dbg_block; /* Debug block. */
255 _PLONG gevect; /* XXX General vector??? */
256 _PLONG utlbvect; /* XXX UTLB vector??? */
257 ULONG rveclen; /* Size of romvec struct. */
258 _PVOID romvec; /* Function interface. */
259 ULONG pveclen; /* Length of private vector. */
260 _PVOID pvector; /* Private vector. */
261 ULONG adap_cnt; /* Adapter count. */
262 ULONG adap_typ0; /* First adapter type. */
263 ULONG adap_vcnt0; /* Adapter 0 vector count. */
264 _PVOID adap_vector; /* Adapter 0 vector ptr. */
265 ULONG adap_typ1; /* Second adapter type. */
266 ULONG adap_vcnt1; /* Adapter 1 vector count. */
267 _PVOID adap_vector1; /* Adapter 1 vector ptr. */
268 /* More adapter vectors go here... */
269} SYSTEM_PARAMETER_BLOCK, *PSYSTEM_PARAMETER_BLOCK;
270
271#define PROMBLOCK ((PSYSTEM_PARAMETER_BLOCK) (int)0xA0001000)
272#define ROMVECTOR ((struct linux_romvec *) (long)(PROMBLOCK)->romvec)
273
274/* Cache layout parameter block. */
275union linux_cache_key {
276 struct param {
277#ifdef __MIPSEL__
278 unsigned short size;
279 unsigned char lsize;
280 unsigned char bsize;
281#else /* !(__MIPSEL__) */
282 unsigned char bsize;
283 unsigned char lsize;
284 unsigned short size;
285#endif
286 } info;
287 unsigned long allinfo;
288};
289
290/* Configuration data. */
291struct linux_cdata {
292 char *name;
293 int mlen;
294 enum linux_devtypes type;
295};
296
297/* Common SGI ARCS firmware file descriptors. */
298#define SGIPROM_STDIN 0
299#define SGIPROM_STDOUT 1
300
301/* Common SGI ARCS firmware file types. */
302#define SGIPROM_ROFILE 0x01 /* read-only file */
303#define SGIPROM_HFILE 0x02 /* hidden file */
304#define SGIPROM_SFILE 0x04 /* System file */
305#define SGIPROM_AFILE 0x08 /* Archive file */
306#define SGIPROM_DFILE 0x10 /* Directory file */
307#define SGIPROM_DELFILE 0x20 /* Deleted file */
308
309/* SGI ARCS boot record information. */
310struct sgi_partition {
311 unsigned char flag;
312#define SGIPART_UNUSED 0x00
313#define SGIPART_ACTIVE 0x80
314
315 unsigned char shead, ssect, scyl; /* unused */
316 unsigned char systype; /* OS type, Irix or NT */
317 unsigned char ehead, esect, ecyl; /* unused */
318 unsigned char rsect0, rsect1, rsect2, rsect3;
319 unsigned char tsect0, tsect1, tsect2, tsect3;
320};
321
322#define SGIBBLOCK_MAGIC 0xaa55
323#define SGIBBLOCK_MAXPART 0x0004
324
325struct sgi_bootblock {
326 unsigned char _unused[446];
327 struct sgi_partition partitions[SGIBBLOCK_MAXPART];
328 unsigned short magic;
329};
330
331/* BIOS parameter block. */
332struct sgi_bparm_block {
333 unsigned short bytes_sect; /* bytes per sector */
334 unsigned char sect_clust; /* sectors per cluster */
335 unsigned short sect_resv; /* reserved sectors */
336 unsigned char nfats; /* # of allocation tables */
337 unsigned short nroot_dirents; /* # of root directory entries */
338 unsigned short sect_volume; /* sectors in volume */
339 unsigned char media_type; /* media descriptor */
340 unsigned short sect_fat; /* sectors per allocation table */
341 unsigned short sect_track; /* sectors per track */
342 unsigned short nheads; /* # of heads */
343 unsigned short nhsects; /* # of hidden sectors */
344};
345
346struct sgi_bsector {
347 unsigned char jmpinfo[3];
348 unsigned char manuf_name[8];
349 struct sgi_bparm_block info;
350};
351
352/* Debugging block used with SGI symmon symbolic debugger. */
353#define SMB_DEBUG_MAGIC 0xfeeddead
354struct linux_smonblock {
355 unsigned long magic;
356 void (*handler)(void); /* Breakpoint routine. */
357 unsigned long dtable_base; /* Base addr of dbg table. */
358 int (*printf)(const char *fmt, ...);
359 unsigned long btable_base; /* Breakpoint table. */
360 unsigned long mpflushreqs; /* SMP cache flush request list. */
361 unsigned long ntab; /* Name table. */
362 unsigned long stab; /* Symbol table. */
363 int smax; /* Max # of symbols. */
364};
365
366/*
367 * Macros for calling a 32-bit ARC implementation from 64-bit code
368 */
369
370#if defined(CONFIG_MIPS64) && defined(CONFIG_ARC32)
371
372#define __arc_clobbers \
373 "$2","$3" /* ... */, "$8","$9","$10","$11", \
374 "$12","$13","$14","$15","$16","$24","$25","$31"
375
376#define ARC_CALL0(dest) \
377({ long __res; \
378 long __vec = (long) romvec->dest; \
379 __asm__ __volatile__( \
380 "dsubu\t$29, 32\n\t" \
381 "jalr\t%1\n\t" \
382 "daddu\t$29, 32\n\t" \
383 "move\t%0, $2" \
384 : "=r" (__res), "=r" (__vec) \
385 : "1" (__vec) \
386 : __arc_clobbers, "$4","$5","$6","$7"); \
387 (unsigned long) __res; \
388})
389
390#define ARC_CALL1(dest,a1) \
391({ long __res; \
392 register signed int __a1 __asm__("$4") = (int) (long) (a1); \
393 long __vec = (long) romvec->dest; \
394 __asm__ __volatile__( \
395 "dsubu\t$29, 32\n\t" \
396 "jalr\t%1\n\t" \
397 "daddu\t$29, 32\n\t" \
398 "move\t%0, $2" \
399 : "=r" (__res), "=r" (__vec) \
400 : "1" (__vec), "r" (__a1) \
401 : __arc_clobbers, "$5","$6","$7"); \
402 (unsigned long) __res; \
403})
404
405#define ARC_CALL2(dest,a1,a2) \
406({ long __res; \
407 register signed int __a1 __asm__("$4") = (int) (long) (a1); \
408 register signed int __a2 __asm__("$5") = (int) (long) (a2); \
409 long __vec = (long) romvec->dest; \
410 __asm__ __volatile__( \
411 "dsubu\t$29, 32\n\t" \
412 "jalr\t%1\n\t" \
413 "daddu\t$29, 32\n\t" \
414 "move\t%0, $2" \
415 : "=r" (__res), "=r" (__vec) \
416 : "1" (__vec), "r" (__a1), "r" (__a2) \
417 : __arc_clobbers, "$6","$7"); \
418 __res; \
419})
420
421#define ARC_CALL3(dest,a1,a2,a3) \
422({ long __res; \
423 register signed int __a1 __asm__("$4") = (int) (long) (a1); \
424 register signed int __a2 __asm__("$5") = (int) (long) (a2); \
425 register signed int __a3 __asm__("$6") = (int) (long) (a3); \
426 long __vec = (long) romvec->dest; \
427 __asm__ __volatile__( \
428 "dsubu\t$29, 32\n\t" \
429 "jalr\t%1\n\t" \
430 "daddu\t$29, 32\n\t" \
431 "move\t%0, $2" \
432 : "=r" (__res), "=r" (__vec) \
433 : "1" (__vec), "r" (__a1), "r" (__a2), "r" (__a3) \
434 : __arc_clobbers, "$7"); \
435 __res; \
436})
437
438#define ARC_CALL4(dest,a1,a2,a3,a4) \
439({ long __res; \
440 register signed int __a1 __asm__("$4") = (int) (long) (a1); \
441 register signed int __a2 __asm__("$5") = (int) (long) (a2); \
442 register signed int __a3 __asm__("$6") = (int) (long) (a3); \
443 register signed int __a4 __asm__("$7") = (int) (long) (a4); \
444 long __vec = (long) romvec->dest; \
445 __asm__ __volatile__( \
446 "dsubu\t$29, 32\n\t" \
447 "jalr\t%1\n\t" \
448 "daddu\t$29, 32\n\t" \
449 "move\t%0, $2" \
450 : "=r" (__res), "=r" (__vec) \
451 : "1" (__vec), "r" (__a1), "r" (__a2), "r" (__a3), \
452 "r" (__a4) \
453 : __arc_clobbers); \
454 __res; \
455})
456
457#define ARC_CALL5(dest,a1,a2,a3,a4,a5) \
458({ long __res; \
459 register signed int __a1 __asm__("$4") = (int) (long) (a1); \
460 register signed int __a2 __asm__("$5") = (int) (long) (a2); \
461 register signed int __a3 __asm__("$6") = (int) (long) (a3); \
462 register signed int __a4 __asm__("$7") = (int) (long) (a4); \
463 register signed int __a5 = (a5); \
464 long __vec = (long) romvec->dest; \
465 __asm__ __volatile__( \
466 "dsubu\t$29, 32\n\t" \
467 "sw\t%7, 16($29)\n\t" \
468 "jalr\t%1\n\t" \
469 "daddu\t$29, 32\n\t" \
470 "move\t%0, $2" \
471 : "=r" (__res), "=r" (__vec) \
472 : "1" (__vec), \
473 "r" (__a1), "r" (__a2), "r" (__a3), "r" (__a4), \
474 "r" (__a5) \
475 : __arc_clobbers); \
476 __res; \
477})
478
479#endif /* defined(CONFIG_MIPS64) && defined(CONFIG_ARC32) */
480
481#if (defined(CONFIG_MIPS32) && defined(CONFIG_ARC32)) || \
482 (defined(CONFIG_MIPS64) && defined(CONFIG_ARC64))
483
484#define ARC_CALL0(dest) \
485({ long __res; \
486 long (*__vec)(void) = (void *) romvec->dest; \
487 \
488 __res = __vec(); \
489 __res; \
490})
491
492#define ARC_CALL1(dest,a1) \
493({ long __res; \
494 long __a1 = (long) (a1); \
495 long (*__vec)(long) = (void *) romvec->dest; \
496 \
497 __res = __vec(__a1); \
498 __res; \
499})
500
501#define ARC_CALL2(dest,a1,a2) \
502({ long __res; \
503 long __a1 = (long) (a1); \
504 long __a2 = (long) (a2); \
505 long (*__vec)(long, long) = (void *) romvec->dest; \
506 \
507 __res = __vec(__a1, __a2); \
508 __res; \
509})
510
511#define ARC_CALL3(dest,a1,a2,a3) \
512({ long __res; \
513 long __a1 = (long) (a1); \
514 long __a2 = (long) (a2); \
515 long __a3 = (long) (a3); \
516 long (*__vec)(long, long, long) = (void *) romvec->dest; \
517 \
518 __res = __vec(__a1, __a2, __a3); \
519 __res; \
520})
521
522#define ARC_CALL4(dest,a1,a2,a3,a4) \
523({ long __res; \
524 long __a1 = (long) (a1); \
525 long __a2 = (long) (a2); \
526 long __a3 = (long) (a3); \
527 long __a4 = (long) (a4); \
528 long (*__vec)(long, long, long, long) = (void *) romvec->dest; \
529 \
530 __res = __vec(__a1, __a2, __a3, __a4); \
531 __res; \
532})
533
534#define ARC_CALL5(dest,a1,a2,a3,a4,a5) \
535({ long __res; \
536 long __a1 = (long) (a1); \
537 long __a2 = (long) (a2); \
538 long __a3 = (long) (a3); \
539 long __a4 = (long) (a4); \
540 long __a5 = (long) (a5); \
541 long (*__vec)(long, long, long, long, long); \
542 __vec = (void *) romvec->dest; \
543 \
544 __res = __vec(__a1, __a2, __a3, __a4, __a5); \
545 __res; \
546})
547#endif /* both kernel and ARC either 32-bit or 64-bit */
548
549#endif /* _ASM_SGIARCS_H */