1*b2441318SGreg Kroah-Hartman /* SPDX-License-Identifier: GPL-2.0 */ 27c59d28dSSam Ravnborg #ifndef __SPARC_OPENPROM_H 37c59d28dSSam Ravnborg #define __SPARC_OPENPROM_H 47c59d28dSSam Ravnborg 57c59d28dSSam Ravnborg /* openprom.h: Prom structures and defines for access to the OPENBOOT 67c59d28dSSam Ravnborg * prom routines and data areas. 77c59d28dSSam Ravnborg * 87c59d28dSSam Ravnborg * Copyright (C) 1995,1996 David S. Miller (davem@caip.rutgers.edu) 97c59d28dSSam Ravnborg */ 107c59d28dSSam Ravnborg 117c59d28dSSam Ravnborg /* Empirical constants... */ 127c59d28dSSam Ravnborg #define LINUX_OPPROM_MAGIC 0x10010407 137c59d28dSSam Ravnborg 147c59d28dSSam Ravnborg #ifndef __ASSEMBLY__ 158d125562SAndres Salomon #include <linux/of.h> 168d125562SAndres Salomon 177c59d28dSSam Ravnborg /* V0 prom device operations. */ 187c59d28dSSam Ravnborg struct linux_dev_v0_funcs { 197c59d28dSSam Ravnborg int (*v0_devopen)(char *device_str); 207c59d28dSSam Ravnborg int (*v0_devclose)(int dev_desc); 217c59d28dSSam Ravnborg int (*v0_rdblkdev)(int dev_desc, int num_blks, int blk_st, char *buf); 227c59d28dSSam Ravnborg int (*v0_wrblkdev)(int dev_desc, int num_blks, int blk_st, char *buf); 237c59d28dSSam Ravnborg int (*v0_wrnetdev)(int dev_desc, int num_bytes, char *buf); 247c59d28dSSam Ravnborg int (*v0_rdnetdev)(int dev_desc, int num_bytes, char *buf); 257c59d28dSSam Ravnborg int (*v0_rdchardev)(int dev_desc, int num_bytes, int dummy, char *buf); 267c59d28dSSam Ravnborg int (*v0_wrchardev)(int dev_desc, int num_bytes, int dummy, char *buf); 277c59d28dSSam Ravnborg int (*v0_seekdev)(int dev_desc, long logical_offst, int from); 287c59d28dSSam Ravnborg }; 297c59d28dSSam Ravnborg 307c59d28dSSam Ravnborg /* V2 and later prom device operations. */ 317c59d28dSSam Ravnborg struct linux_dev_v2_funcs { 328d125562SAndres Salomon phandle (*v2_inst2pkg)(int d); /* Convert ihandle to phandle */ 339ef595d8SJoe Perches char * (*v2_dumb_mem_alloc)(char *va, unsigned int sz); 349ef595d8SJoe Perches void (*v2_dumb_mem_free)(char *va, unsigned int sz); 357c59d28dSSam Ravnborg 367c59d28dSSam Ravnborg /* To map devices into virtual I/O space. */ 379ef595d8SJoe Perches char * (*v2_dumb_mmap)(char *virta, int which_io, unsigned int paddr, unsigned int sz); 389ef595d8SJoe Perches void (*v2_dumb_munmap)(char *virta, unsigned int size); 397c59d28dSSam Ravnborg 407c59d28dSSam Ravnborg int (*v2_dev_open)(char *devpath); 417c59d28dSSam Ravnborg void (*v2_dev_close)(int d); 427c59d28dSSam Ravnborg int (*v2_dev_read)(int d, char *buf, int nbytes); 43e62cac1fSDavid S. Miller int (*v2_dev_write)(int d, const char *buf, int nbytes); 447c59d28dSSam Ravnborg int (*v2_dev_seek)(int d, int hi, int lo); 457c59d28dSSam Ravnborg 467c59d28dSSam Ravnborg /* Never issued (multistage load support) */ 477c59d28dSSam Ravnborg void (*v2_wheee2)(void); 487c59d28dSSam Ravnborg void (*v2_wheee3)(void); 497c59d28dSSam Ravnborg }; 507c59d28dSSam Ravnborg 517c59d28dSSam Ravnborg struct linux_mlist_v0 { 527c59d28dSSam Ravnborg struct linux_mlist_v0 *theres_more; 537c59d28dSSam Ravnborg unsigned int start_adr; 549ef595d8SJoe Perches unsigned int num_bytes; 557c59d28dSSam Ravnborg }; 567c59d28dSSam Ravnborg 577c59d28dSSam Ravnborg struct linux_mem_v0 { 587c59d28dSSam Ravnborg struct linux_mlist_v0 **v0_totphys; 597c59d28dSSam Ravnborg struct linux_mlist_v0 **v0_prommap; 607c59d28dSSam Ravnborg struct linux_mlist_v0 **v0_available; /* What we can use */ 617c59d28dSSam Ravnborg }; 627c59d28dSSam Ravnborg 637c59d28dSSam Ravnborg /* Arguments sent to the kernel from the boot prompt. */ 647c59d28dSSam Ravnborg struct linux_arguments_v0 { 657c59d28dSSam Ravnborg char *argv[8]; 667c59d28dSSam Ravnborg char args[100]; 677c59d28dSSam Ravnborg char boot_dev[2]; 687c59d28dSSam Ravnborg int boot_dev_ctrl; 697c59d28dSSam Ravnborg int boot_dev_unit; 707c59d28dSSam Ravnborg int dev_partition; 717c59d28dSSam Ravnborg char *kernel_file_name; 727c59d28dSSam Ravnborg void *aieee1; /* XXX */ 737c59d28dSSam Ravnborg }; 747c59d28dSSam Ravnborg 757c59d28dSSam Ravnborg /* V2 and up boot things. */ 767c59d28dSSam Ravnborg struct linux_bootargs_v2 { 777c59d28dSSam Ravnborg char **bootpath; 787c59d28dSSam Ravnborg char **bootargs; 797c59d28dSSam Ravnborg int *fd_stdin; 807c59d28dSSam Ravnborg int *fd_stdout; 817c59d28dSSam Ravnborg }; 827c59d28dSSam Ravnborg 837c59d28dSSam Ravnborg /* The top level PROM vector. */ 847c59d28dSSam Ravnborg struct linux_romvec { 857c59d28dSSam Ravnborg /* Version numbers. */ 867c59d28dSSam Ravnborg unsigned int pv_magic_cookie; 877c59d28dSSam Ravnborg unsigned int pv_romvers; 887c59d28dSSam Ravnborg unsigned int pv_plugin_revision; 897c59d28dSSam Ravnborg unsigned int pv_printrev; 907c59d28dSSam Ravnborg 917c59d28dSSam Ravnborg /* Version 0 memory descriptors. */ 927c59d28dSSam Ravnborg struct linux_mem_v0 pv_v0mem; 937c59d28dSSam Ravnborg 947c59d28dSSam Ravnborg /* Node operations. */ 957c59d28dSSam Ravnborg struct linux_nodeops *pv_nodeops; 967c59d28dSSam Ravnborg 977c59d28dSSam Ravnborg char **pv_bootstr; 987c59d28dSSam Ravnborg struct linux_dev_v0_funcs pv_v0devops; 997c59d28dSSam Ravnborg 1007c59d28dSSam Ravnborg char *pv_stdin; 1017c59d28dSSam Ravnborg char *pv_stdout; 1027c59d28dSSam Ravnborg #define PROMDEV_KBD 0 /* input from keyboard */ 1037c59d28dSSam Ravnborg #define PROMDEV_SCREEN 0 /* output to screen */ 1047c59d28dSSam Ravnborg #define PROMDEV_TTYA 1 /* in/out to ttya */ 1057c59d28dSSam Ravnborg #define PROMDEV_TTYB 2 /* in/out to ttyb */ 1067c59d28dSSam Ravnborg 1077c59d28dSSam Ravnborg /* Blocking getchar/putchar. NOT REENTRANT! (grr) */ 1087c59d28dSSam Ravnborg int (*pv_getchar)(void); 1097c59d28dSSam Ravnborg void (*pv_putchar)(int ch); 1107c59d28dSSam Ravnborg 1117c59d28dSSam Ravnborg /* Non-blocking variants. */ 1127c59d28dSSam Ravnborg int (*pv_nbgetchar)(void); 1137c59d28dSSam Ravnborg int (*pv_nbputchar)(int ch); 1147c59d28dSSam Ravnborg 1157c59d28dSSam Ravnborg void (*pv_putstr)(char *str, int len); 1167c59d28dSSam Ravnborg 1177c59d28dSSam Ravnborg /* Miscellany. */ 1187c59d28dSSam Ravnborg void (*pv_reboot)(char *bootstr); 1197c59d28dSSam Ravnborg void (*pv_printf)(__const__ char *fmt, ...); 1207c59d28dSSam Ravnborg void (*pv_abort)(void); 1217c59d28dSSam Ravnborg __volatile__ int *pv_ticks; 1227c59d28dSSam Ravnborg void (*pv_halt)(void); 1237c59d28dSSam Ravnborg void (**pv_synchook)(void); 1247c59d28dSSam Ravnborg 1257c59d28dSSam Ravnborg /* Evaluate a forth string, not different proto for V0 and V2->up. */ 1267c59d28dSSam Ravnborg union { 1277c59d28dSSam Ravnborg void (*v0_eval)(int len, char *str); 1287c59d28dSSam Ravnborg void (*v2_eval)(char *str); 1297c59d28dSSam Ravnborg } pv_fortheval; 1307c59d28dSSam Ravnborg 1317c59d28dSSam Ravnborg struct linux_arguments_v0 **pv_v0bootargs; 1327c59d28dSSam Ravnborg 1337c59d28dSSam Ravnborg /* Get ether address. */ 1347c59d28dSSam Ravnborg unsigned int (*pv_enaddr)(int d, char *enaddr); 1357c59d28dSSam Ravnborg 1367c59d28dSSam Ravnborg struct linux_bootargs_v2 pv_v2bootargs; 1377c59d28dSSam Ravnborg struct linux_dev_v2_funcs pv_v2devops; 1387c59d28dSSam Ravnborg 1397c59d28dSSam Ravnborg int filler[15]; 1407c59d28dSSam Ravnborg 1417c59d28dSSam Ravnborg /* This one is sun4c/sun4 only. */ 1427c59d28dSSam Ravnborg void (*pv_setctxt)(int ctxt, char *va, int pmeg); 1437c59d28dSSam Ravnborg 1447c59d28dSSam Ravnborg /* Prom version 3 Multiprocessor routines. This stuff is crazy. 1457c59d28dSSam Ravnborg * No joke. Calling these when there is only one cpu probably 1467c59d28dSSam Ravnborg * crashes the machine, have to test this. :-) 1477c59d28dSSam Ravnborg */ 1487c59d28dSSam Ravnborg 1497c59d28dSSam Ravnborg /* v3_cpustart() will start the cpu 'whichcpu' in mmu-context 1507c59d28dSSam Ravnborg * 'thiscontext' executing at address 'prog_counter' 1517c59d28dSSam Ravnborg */ 1527c59d28dSSam Ravnborg int (*v3_cpustart)(unsigned int whichcpu, int ctxtbl_ptr, 1537c59d28dSSam Ravnborg int thiscontext, char *prog_counter); 1547c59d28dSSam Ravnborg 1557c59d28dSSam Ravnborg /* v3_cpustop() will cause cpu 'whichcpu' to stop executing 1567c59d28dSSam Ravnborg * until a resume cpu call is made. 1577c59d28dSSam Ravnborg */ 1587c59d28dSSam Ravnborg int (*v3_cpustop)(unsigned int whichcpu); 1597c59d28dSSam Ravnborg 1607c59d28dSSam Ravnborg /* v3_cpuidle() will idle cpu 'whichcpu' until a stop or 1617c59d28dSSam Ravnborg * resume cpu call is made. 1627c59d28dSSam Ravnborg */ 1637c59d28dSSam Ravnborg int (*v3_cpuidle)(unsigned int whichcpu); 1647c59d28dSSam Ravnborg 1657c59d28dSSam Ravnborg /* v3_cpuresume() will resume processor 'whichcpu' executing 1667c59d28dSSam Ravnborg * starting with whatever 'pc' and 'npc' were left at the 1677c59d28dSSam Ravnborg * last 'idle' or 'stop' call. 1687c59d28dSSam Ravnborg */ 1697c59d28dSSam Ravnborg int (*v3_cpuresume)(unsigned int whichcpu); 1707c59d28dSSam Ravnborg }; 1717c59d28dSSam Ravnborg 1727c59d28dSSam Ravnborg /* Routines for traversing the prom device tree. */ 1737c59d28dSSam Ravnborg struct linux_nodeops { 1748d125562SAndres Salomon phandle (*no_nextnode)(phandle node); 1758d125562SAndres Salomon phandle (*no_child)(phandle node); 1768d125562SAndres Salomon int (*no_proplen)(phandle node, const char *name); 1778d125562SAndres Salomon int (*no_getprop)(phandle node, const char *name, char *val); 1788d125562SAndres Salomon int (*no_setprop)(phandle node, const char *name, char *val, int len); 1798d125562SAndres Salomon char * (*no_nextprop)(phandle node, char *name); 1807c59d28dSSam Ravnborg }; 1817c59d28dSSam Ravnborg 1827c59d28dSSam Ravnborg /* More fun PROM structures for device probing. */ 183a439fe51SSam Ravnborg #if defined(__sparc__) && defined(__arch64__) 1847c59d28dSSam Ravnborg #define PROMREG_MAX 24 1857c59d28dSSam Ravnborg #define PROMVADDR_MAX 16 1867c59d28dSSam Ravnborg #define PROMINTR_MAX 32 187a439fe51SSam Ravnborg #else 1887c59d28dSSam Ravnborg #define PROMREG_MAX 16 1897c59d28dSSam Ravnborg #define PROMVADDR_MAX 16 1907c59d28dSSam Ravnborg #define PROMINTR_MAX 15 191a439fe51SSam Ravnborg #endif 1927c59d28dSSam Ravnborg 1937c59d28dSSam Ravnborg struct linux_prom_registers { 1947c59d28dSSam Ravnborg unsigned int which_io; /* hi part of physical address */ 1957c59d28dSSam Ravnborg unsigned int phys_addr; /* The physical address of this register */ 1967c59d28dSSam Ravnborg unsigned int reg_size; /* How many bytes does this register take up? */ 1977c59d28dSSam Ravnborg }; 1987c59d28dSSam Ravnborg 1997c59d28dSSam Ravnborg struct linux_prom64_registers { 2007c59d28dSSam Ravnborg unsigned long phys_addr; 2017c59d28dSSam Ravnborg unsigned long reg_size; 2027c59d28dSSam Ravnborg }; 2037c59d28dSSam Ravnborg 2047c59d28dSSam Ravnborg struct linux_prom_irqs { 2057c59d28dSSam Ravnborg int pri; /* IRQ priority */ 2067c59d28dSSam Ravnborg int vector; /* This is foobar, what does it do? */ 2077c59d28dSSam Ravnborg }; 2087c59d28dSSam Ravnborg 2097c59d28dSSam Ravnborg /* Element of the "ranges" vector */ 2107c59d28dSSam Ravnborg struct linux_prom_ranges { 2117c59d28dSSam Ravnborg unsigned int ot_child_space; 2127c59d28dSSam Ravnborg unsigned int ot_child_base; /* Bus feels this */ 2137c59d28dSSam Ravnborg unsigned int ot_parent_space; 2147c59d28dSSam Ravnborg unsigned int ot_parent_base; /* CPU looks from here */ 2157c59d28dSSam Ravnborg unsigned int or_size; 2167c59d28dSSam Ravnborg }; 2177c59d28dSSam Ravnborg 2187c59d28dSSam Ravnborg /* 2197c59d28dSSam Ravnborg * Ranges and reg properties are a bit different for PCI. 2207c59d28dSSam Ravnborg */ 2217c59d28dSSam Ravnborg #if defined(__sparc__) && defined(__arch64__) 2227c59d28dSSam Ravnborg struct linux_prom_pci_registers { 2237c59d28dSSam Ravnborg unsigned int phys_hi; 2247c59d28dSSam Ravnborg unsigned int phys_mid; 2257c59d28dSSam Ravnborg unsigned int phys_lo; 2267c59d28dSSam Ravnborg 2277c59d28dSSam Ravnborg unsigned int size_hi; 2287c59d28dSSam Ravnborg unsigned int size_lo; 2297c59d28dSSam Ravnborg }; 2307c59d28dSSam Ravnborg #else 2317c59d28dSSam Ravnborg struct linux_prom_pci_registers { 2327c59d28dSSam Ravnborg /* 2337c59d28dSSam Ravnborg * We don't know what information this field contain. 2347c59d28dSSam Ravnborg * We guess, PCI device function is in bits 15:8 2357c59d28dSSam Ravnborg * So, ... 2367c59d28dSSam Ravnborg */ 2377c59d28dSSam Ravnborg unsigned int which_io; /* Let it be which_io */ 2387c59d28dSSam Ravnborg 2397c59d28dSSam Ravnborg unsigned int phys_hi; 2407c59d28dSSam Ravnborg unsigned int phys_lo; 2417c59d28dSSam Ravnborg 2427c59d28dSSam Ravnborg unsigned int size_hi; 2437c59d28dSSam Ravnborg unsigned int size_lo; 2447c59d28dSSam Ravnborg }; 2457c59d28dSSam Ravnborg 246a439fe51SSam Ravnborg #endif 2477c59d28dSSam Ravnborg 2487c59d28dSSam Ravnborg struct linux_prom_pci_ranges { 2497c59d28dSSam Ravnborg unsigned int child_phys_hi; /* Only certain bits are encoded here. */ 2507c59d28dSSam Ravnborg unsigned int child_phys_mid; 2517c59d28dSSam Ravnborg unsigned int child_phys_lo; 2527c59d28dSSam Ravnborg 2537c59d28dSSam Ravnborg unsigned int parent_phys_hi; 2547c59d28dSSam Ravnborg unsigned int parent_phys_lo; 2557c59d28dSSam Ravnborg 2567c59d28dSSam Ravnborg unsigned int size_hi; 2577c59d28dSSam Ravnborg unsigned int size_lo; 2587c59d28dSSam Ravnborg }; 2597c59d28dSSam Ravnborg 2607c59d28dSSam Ravnborg struct linux_prom_pci_intmap { 2617c59d28dSSam Ravnborg unsigned int phys_hi; 2627c59d28dSSam Ravnborg unsigned int phys_mid; 2637c59d28dSSam Ravnborg unsigned int phys_lo; 2647c59d28dSSam Ravnborg 2657c59d28dSSam Ravnborg unsigned int interrupt; 2667c59d28dSSam Ravnborg 2677c59d28dSSam Ravnborg int cnode; 2687c59d28dSSam Ravnborg unsigned int cinterrupt; 2697c59d28dSSam Ravnborg }; 2707c59d28dSSam Ravnborg 2717c59d28dSSam Ravnborg struct linux_prom_pci_intmask { 2727c59d28dSSam Ravnborg unsigned int phys_hi; 2737c59d28dSSam Ravnborg unsigned int phys_mid; 2747c59d28dSSam Ravnborg unsigned int phys_lo; 2757c59d28dSSam Ravnborg unsigned int interrupt; 2767c59d28dSSam Ravnborg }; 2777c59d28dSSam Ravnborg 2787c59d28dSSam Ravnborg #endif /* !(__ASSEMBLY__) */ 2797c59d28dSSam Ravnborg 2807c59d28dSSam Ravnborg #endif /* !(__SPARC_OPENPROM_H) */ 281