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