1 /* $Id: openprom.h,v 1.24 2000/06/04 06:23:53 anton Exp $ */
 
   2 #ifndef __SPARC_OPENPROM_H
 
   3 #define __SPARC_OPENPROM_H
 
   5 /* openprom.h:  Prom structures and defines for access to the OPENBOOT
 
   6  *              prom routines and data areas.
 
   8  * Copyright (C) 1995 David S. Miller (davem@caip.rutgers.edu)
 
  11 #include <asm/vaddrs.h>
 
  13 /* Empirical constants... */
 
  14 #define LINUX_OPPROM_MAGIC      0x10010407
 
  17 /* V0 prom device operations. */
 
  18 struct linux_dev_v0_funcs {
 
  19         int (*v0_devopen)(char *device_str);
 
  20         int (*v0_devclose)(int dev_desc);
 
  21         int (*v0_rdblkdev)(int dev_desc, int num_blks, int blk_st, char *buf);
 
  22         int (*v0_wrblkdev)(int dev_desc, int num_blks, int blk_st, char *buf);
 
  23         int (*v0_wrnetdev)(int dev_desc, int num_bytes, char *buf);
 
  24         int (*v0_rdnetdev)(int dev_desc, int num_bytes, char *buf);
 
  25         int (*v0_rdchardev)(int dev_desc, int num_bytes, int dummy, char *buf);
 
  26         int (*v0_wrchardev)(int dev_desc, int num_bytes, int dummy, char *buf);
 
  27         int (*v0_seekdev)(int dev_desc, long logical_offst, int from);
 
  30 /* V2 and later prom device operations. */
 
  31 struct linux_dev_v2_funcs {
 
  32         int (*v2_inst2pkg)(int d);      /* Convert ihandle to phandle */
 
  33         char * (*v2_dumb_mem_alloc)(char *va, unsigned sz);
 
  34         void (*v2_dumb_mem_free)(char *va, unsigned sz);
 
  36         /* To map devices into virtual I/O space. */
 
  37         char * (*v2_dumb_mmap)(char *virta, int which_io, unsigned paddr, unsigned sz);
 
  38         void (*v2_dumb_munmap)(char *virta, unsigned size);
 
  40         int (*v2_dev_open)(char *devpath);
 
  41         void (*v2_dev_close)(int d);
 
  42         int (*v2_dev_read)(int d, char *buf, int nbytes);
 
  43         int (*v2_dev_write)(int d, char *buf, int nbytes);
 
  44         int (*v2_dev_seek)(int d, int hi, int lo);
 
  46         /* Never issued (multistage load support) */
 
  47         void (*v2_wheee2)(void);
 
  48         void (*v2_wheee3)(void);
 
  51 struct linux_mlist_v0 {
 
  52         struct linux_mlist_v0 *theres_more;
 
  58         struct linux_mlist_v0 **v0_totphys;
 
  59         struct linux_mlist_v0 **v0_prommap;
 
  60         struct linux_mlist_v0 **v0_available; /* What we can use */
 
  63 /* Arguments sent to the kernel from the boot prompt. */
 
  64 struct linux_arguments_v0 {
 
  71         char *kernel_file_name;
 
  72         void *aieee1;           /* XXX */
 
  75 /* V2 and up boot things. */
 
  76 struct linux_bootargs_v2 {
 
  83 /* The top level PROM vector. */
 
  85         /* Version numbers. */
 
  86         unsigned int pv_magic_cookie;
 
  87         unsigned int pv_romvers;
 
  88         unsigned int pv_plugin_revision;
 
  89         unsigned int pv_printrev;
 
  91         /* Version 0 memory descriptors. */
 
  92         struct linux_mem_v0 pv_v0mem;
 
  94         /* Node operations. */
 
  95         struct linux_nodeops *pv_nodeops;
 
  98         struct linux_dev_v0_funcs pv_v0devops;
 
 102 #define PROMDEV_KBD     0               /* input from keyboard */
 
 103 #define PROMDEV_SCREEN  0               /* output to screen */
 
 104 #define PROMDEV_TTYA    1               /* in/out to ttya */
 
 105 #define PROMDEV_TTYB    2               /* in/out to ttyb */
 
 107         /* Blocking getchar/putchar.  NOT REENTRANT! (grr) */
 
 108         int (*pv_getchar)(void);
 
 109         void (*pv_putchar)(int ch);
 
 111         /* Non-blocking variants. */
 
 112         int (*pv_nbgetchar)(void);
 
 113         int (*pv_nbputchar)(int ch);
 
 115         void (*pv_putstr)(char *str, int len);
 
 118         void (*pv_reboot)(char *bootstr);
 
 119         void (*pv_printf)(__const__ char *fmt, ...);
 
 120         void (*pv_abort)(void);
 
 121         __volatile__ int *pv_ticks;
 
 122         void (*pv_halt)(void);
 
 123         void (**pv_synchook)(void);
 
 125         /* Evaluate a forth string, not different proto for V0 and V2->up. */
 
 127                 void (*v0_eval)(int len, char *str);
 
 128                 void (*v2_eval)(char *str);
 
 131         struct linux_arguments_v0 **pv_v0bootargs;
 
 133         /* Get ether address. */
 
 134         unsigned int (*pv_enaddr)(int d, char *enaddr);
 
 136         struct linux_bootargs_v2 pv_v2bootargs;
 
 137         struct linux_dev_v2_funcs pv_v2devops;
 
 141         /* This one is sun4c/sun4 only. */
 
 142         void (*pv_setctxt)(int ctxt, char *va, int pmeg);
 
 144         /* Prom version 3 Multiprocessor routines. This stuff is crazy.
 
 145          * No joke. Calling these when there is only one cpu probably
 
 146          * crashes the machine, have to test this. :-)
 
 149         /* v3_cpustart() will start the cpu 'whichcpu' in mmu-context
 
 150          * 'thiscontext' executing at address 'prog_counter'
 
 152         int (*v3_cpustart)(unsigned int whichcpu, int ctxtbl_ptr,
 
 153                            int thiscontext, char *prog_counter);
 
 155         /* v3_cpustop() will cause cpu 'whichcpu' to stop executing
 
 156          * until a resume cpu call is made.
 
 158         int (*v3_cpustop)(unsigned int whichcpu);
 
 160         /* v3_cpuidle() will idle cpu 'whichcpu' until a stop or
 
 161          * resume cpu call is made.
 
 163         int (*v3_cpuidle)(unsigned int whichcpu);
 
 165         /* v3_cpuresume() will resume processor 'whichcpu' executing
 
 166          * starting with whatever 'pc' and 'npc' were left at the
 
 167          * last 'idle' or 'stop' call.
 
 169         int (*v3_cpuresume)(unsigned int whichcpu);
 
 172 /* Routines for traversing the prom device tree. */
 
 173 struct linux_nodeops {
 
 174         int (*no_nextnode)(int node);
 
 175         int (*no_child)(int node);
 
 176         int (*no_proplen)(int node, char *name);
 
 177         int (*no_getprop)(int node, char *name, char *val);
 
 178         int (*no_setprop)(int node, char *name, char *val, int len);
 
 179         char * (*no_nextprop)(int node, char *name);
 
 182 /* More fun PROM structures for device probing. */
 
 183 #define PROMREG_MAX     16
 
 184 #define PROMVADDR_MAX   16
 
 185 #define PROMINTR_MAX    15
 
 187 struct linux_prom_registers {
 
 188         unsigned int which_io;         /* is this in OBIO space? */
 
 189         unsigned int phys_addr;        /* The physical address of this register */
 
 190         unsigned int reg_size;         /* How many bytes does this register take up? */
 
 193 struct linux_prom_irqs {
 
 194         int pri;    /* IRQ priority */
 
 195         int vector; /* This is foobar, what does it do? */
 
 198 /* Element of the "ranges" vector */
 
 199 struct linux_prom_ranges {
 
 200         unsigned int ot_child_space;
 
 201         unsigned int ot_child_base;             /* Bus feels this */
 
 202         unsigned int ot_parent_space;
 
 203         unsigned int ot_parent_base;            /* CPU looks from here */
 
 204         unsigned int or_size;
 
 207 /* Ranges and reg properties are a bit different for PCI. */
 
 208 struct linux_prom_pci_registers {
 
 210          * We don't know what information this field contain.
 
 211          * We guess, PCI device function is in bits 15:8
 
 214         unsigned int which_io;  /* Let it be which_io */
 
 216         unsigned int phys_hi;
 
 217         unsigned int phys_lo;
 
 219         unsigned int size_hi;
 
 220         unsigned int size_lo;
 
 223 struct linux_prom_pci_ranges {
 
 224         unsigned int child_phys_hi;     /* Only certain bits are encoded here. */
 
 225         unsigned int child_phys_mid;
 
 226         unsigned int child_phys_lo;
 
 228         unsigned int parent_phys_hi;
 
 229         unsigned int parent_phys_lo;
 
 231         unsigned int size_hi;
 
 232         unsigned int size_lo;
 
 235 struct linux_prom_pci_assigned_addresses {
 
 236         unsigned int which_io;
 
 238         unsigned int phys_hi;
 
 239         unsigned int phys_lo;
 
 241         unsigned int size_hi;
 
 242         unsigned int size_lo;
 
 245 struct linux_prom_ebus_ranges {
 
 246         unsigned int child_phys_hi;
 
 247         unsigned int child_phys_lo;
 
 249         unsigned int parent_phys_hi;
 
 250         unsigned int parent_phys_mid;
 
 251         unsigned int parent_phys_lo;
 
 256 #endif /* !(__ASSEMBLY__) */
 
 258 #endif /* !(__SPARC_OPENPROM_H) */