1 /* 2 * CDDL HEADER START 3 * 4 * The contents of this file are subject to the terms of the 5 * Common Development and Distribution License (the "License"). 6 * You may not use this file except in compliance with the License. 7 * 8 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE 9 * or http://www.opensolaris.org/os/licensing. 10 * See the License for the specific language governing permissions 11 * and limitations under the License. 12 * 13 * When distributing Covered Code, include this CDDL HEADER in each 14 * file and include the License file at usr/src/OPENSOLARIS.LICENSE. 15 * If applicable, add the following below this CDDL HEADER, with the 16 * fields enclosed by brackets "[]" replaced with your own identifying 17 * information: Portions Copyright [yyyy] [name of copyright owner] 18 * 19 * CDDL HEADER END 20 */ 21 /* 22 * Copyright 2007 Sun Microsystems, Inc. All rights reserved. 23 * Use is subject to license terms. 24 */ 25 /* 26 * Copyright 2019 Peter Tribble. 27 */ 28 29 #ifndef _SYS_PROM_PLAT_H 30 #define _SYS_PROM_PLAT_H 31 32 #include <sys/feature_tests.h> 33 #include <sys/cpuvar.h> 34 35 #ifdef __cplusplus 36 extern "C" { 37 #endif 38 39 #if !defined(_LONGLONG_TYPE) 40 #error "This header won't work without long long support" 41 #endif 42 43 /* 44 * This file contains external platform-specific promif interface definitions. 45 * There may be none. This file is included by reference in <sys/promif.h> 46 * 47 * This version of the file is for the IEEE 1275-1994 compliant sun4u prom. 48 */ 49 50 /* 51 * Memory allocation plus memory/mmu interfaces: 52 * 53 * Routines with fine-grained memory and MMU control are platform-dependent. 54 * 55 * MMU node virtualized "mode" arguments and results for Spitfire MMU: 56 * 57 * The default virtualized "mode" for client program mappings created 58 * by the firmware is as follows: 59 * 60 * G (global) Clear 61 * L (locked) Clear 62 * W (write) Set 63 * R (read - soft) Set (Prom is not required to implement soft bits) 64 * X (exec - soft) Set (Prom is not required to implement soft bits) 65 * CV,CP (Cacheable) Set if memory page, Clear if IO page 66 * E (side effects) Clear if memory page; Set if IO page 67 * IE (Invert endian.) Clear 68 * 69 * The following fields are initialized as follows in the TTE-data for any 70 * mappings created by the firmware on behalf of the client program: 71 * 72 * P (Priviledged) Set 73 * V (Valid) Set 74 * NFO (No Fault Only) Clear 75 * Context 0 76 * Soft bits < private to the firmware implementation > 77 * 78 * Page size of Prom mappings are typically 8k, "modify" cannot change 79 * page sizes. Mappings created by "map" are 8k pages. 80 * 81 * If the virtualized "mode" is -1, the defaults as shown above are used, 82 * otherwise the virtualized "mode" is set (and returned) based on the 83 * following virtualized "mode" abstractions. The mmu node "translations" 84 * property contains the actual tte-data, not the virtualized "mode". 85 * 86 * Note that client programs may not create locked mappings by setting 87 * the LOCKED bit. There are Spitfire specific client interfaces to create 88 * and remove locked mappings. (SUNW,{i,d}tlb-load). 89 * The LOCKED bit is defined here since it may be returned by the 90 * "translate" method. 91 * 92 * The PROM is not required to implement the Read and eXecute soft bits, 93 * and is not required to track them for the client program. They may be 94 * set on calls to "map" and "modfify" and may be ignored by the firmware, 95 * and are not necessarily returned from "translate". 96 * 97 * The TTE soft bits are private to the firmware. No assumptions may 98 * be made regarding the contents of the TTE soft bits. 99 * 100 * Changing a mapping from cacheable to non-cacheable implies a flush 101 * or invalidate operation, if necessary. 102 * 103 * NB: The "map" MMU node method should NOT be used to create IO device 104 * mappings. The correct way to do this is to call the device's parent 105 * "map-in" method using the CALL-METHOD client interface service. 106 */ 107 108 #define PROM_MMU_MODE_DEFAULT ((int)-1) /* Default "mode", see above */ 109 110 /* 111 * NB: These are not implemented in PROM version P1.0 ... 112 */ 113 #define PROM_MMU_MODE_WRITE 0x0001 /* Translation is Writable */ 114 #define PROM_MMU_MODE_READ 0x0002 /* Soft: Readable, See above */ 115 #define PROM_MMU_MODE_EXEC 0x0004 /* Soft: eXecutable, See above */ 116 #define PROM_MMU_MODE_RWX_MASK 0x0007 /* Mask for R-W-X bits */ 117 118 #define PROM_MMU_MODE_LOCKED 0x0010 /* Read-only: Locked; see above */ 119 #define PROM_MMU_MODE_CACHED 0x0020 /* Set means both CV,CP bits */ 120 #define PROM_MMU_MODE_EFFECTS 0x0040 /* side Effects bit in MMU */ 121 #define PROM_MMU_MODE_GLOBAL 0x0080 /* Global bit */ 122 #define PROM_MMU_MODE_INVERT 0x0100 /* Invert Endianness */ 123 124 /* 125 * resource allocation group: OBP only. (mapping functions are platform 126 * dependent because they use physical address arguments.) 127 */ 128 extern caddr_t prom_map(caddr_t virthint, 129 unsigned long long physaddr, uint_t size); 130 131 /* 132 * prom_alloc is platform dependent and has historical semantics 133 * associated with the align argument and the return value. 134 * prom_malloc is the generic memory allocator. 135 */ 136 extern caddr_t prom_malloc(caddr_t virt, size_t size, uint_t align); 137 138 extern caddr_t prom_allocate_virt(uint_t align, size_t size); 139 extern caddr_t prom_claim_virt(size_t size, caddr_t virt); 140 extern void prom_free_virt(size_t size, caddr_t virt); 141 142 extern int prom_allocate_phys(size_t size, uint_t align, 143 unsigned long long *physaddr); 144 extern int prom_claim_phys(size_t size, 145 unsigned long long physaddr); 146 extern void prom_free_phys(size_t size, 147 unsigned long long physaddr); 148 149 extern int prom_map_phys(int mode, size_t size, caddr_t virt, 150 unsigned long long physaddr); 151 extern void prom_unmap_phys(size_t size, caddr_t virt); 152 extern void prom_unmap_virt(size_t size, caddr_t virt); 153 154 extern int prom_phys_installed_len(void); 155 extern int prom_phys_avail_len(void); 156 extern int prom_virt_avail_len(void); 157 158 extern int prom_phys_installed(caddr_t); 159 extern int prom_phys_avail(caddr_t); 160 extern int prom_virt_avail(caddr_t); 161 162 /* 163 * prom_retain allocates or returns retained physical memory 164 * identified by the arguments of name string "id", "size" and "align". 165 */ 166 extern int prom_retain(char *id, size_t size, uint_t align, 167 unsigned long long *physaddr); 168 169 /* 170 * prom_translate_virt returns the physical address and virtualized "mode" 171 * for the given virtual address. After the call, if *valid is non-zero, 172 * a mapping to 'virt' exists and the physical address and virtualized 173 * "mode" were returned to the caller. 174 */ 175 extern int prom_translate_virt(caddr_t virt, int *valid, 176 unsigned long long *physaddr, int *mode); 177 178 /* 179 * prom_modify_mapping changes the "mode" of an existing mapping or 180 * repeated mappings. virt is the virtual address whose "mode" is to 181 * be changed; size is some multiple of the fundamental pagesize. 182 * This method cannot be used to change the pagesize of an MMU mapping, 183 * nor can it be used to Lock a translation into the i or d tlb. 184 */ 185 extern int prom_modify_mapping(caddr_t virt, size_t size, int mode); 186 187 /* 188 * Client interfaces for managing the {i,d}tlb handoff to client programs. 189 */ 190 extern int prom_itlb_load(int index, 191 unsigned long long tte_data, caddr_t virt); 192 193 extern int prom_dtlb_load(int index, 194 unsigned long long tte_data, caddr_t virt); 195 196 /* 197 * Administrative group: OBP only and SMCC platform specific. 198 * XXX: IDPROM related stuff should be replaced with specific data-oriented 199 * XXX: functions. 200 */ 201 202 extern int prom_heartbeat(int msecs); 203 extern int prom_get_unum(int syn_code, unsigned long long physaddr, 204 char *buf, uint_t buflen, int *ustrlen); 205 extern int prom_serengeti_get_ecacheunum(int cpuid, 206 unsigned long long physaddr, char *buf, 207 uint_t buflen, int *ustrlen); 208 209 extern int prom_getidprom(caddr_t addr, int size); 210 extern int prom_getmacaddr(ihandle_t hd, caddr_t ea); 211 212 /* 213 * CPU Control Group: MP's only. 214 */ 215 extern int prom_startcpu(pnode_t node, caddr_t pc, int arg); 216 extern int prom_startcpu_bycpuid(int cpuid, caddr_t pc, int arg); 217 extern int prom_stopcpu_bycpuid(int); 218 extern int prom_sunfire_cpu_off(void); /* SunFire only */ 219 extern int prom_wakeupcpu(pnode_t node); 220 extern int prom_serengeti_wakeupcpu(pnode_t node); 221 extern int prom_hotaddcpu(int cpuid); 222 extern int prom_hotremovecpu(int cpuid); 223 extern void promsafe_pause_cpus(void); 224 extern void promsafe_xc_attention(cpuset_t cpuset); 225 extern int prom_serengeti_cpu_off(pnode_t node); 226 227 /* 228 * Set trap table 229 */ 230 extern void prom_set_traptable(void *tba_addr); 231 232 /* 233 * Power-off 234 */ 235 extern void prom_power_off(void); 236 237 /* 238 * sunfire attach/detach 239 */ 240 extern int prom_sunfire_attach_board(uint_t board); 241 extern int prom_sunfire_detach_board(uint_t board); 242 243 /* 244 * Serengeti console switch 245 */ 246 extern char *prom_serengeti_set_console_input(char *new_value); 247 248 /* 249 * Serengeti attach/detach 250 */ 251 extern int prom_serengeti_attach_board(uint_t node, uint_t board); 252 extern int prom_serengeti_detach_board(uint_t node, uint_t board); 253 extern int prom_serengeti_tunnel_switch(uint_t node, uint_t board); 254 255 /* 256 * OPL-specific routines 257 */ 258 extern void prom_opl_get_tod(time_t *time, int64_t *stickval); 259 extern void prom_opl_set_diff(int64_t diff); 260 extern int prom_attach_notice(int bn); 261 extern int prom_detach_notice(int bn); 262 extern int prom_opl_switch_console(int bn); 263 264 /* 265 * The client program implementation is required to provide a wrapper 266 * to the client handler, for the 32 bit client program to 64 bit cell-sized 267 * client interface handler (switch stack, etc.). This function is not 268 * to be used externally! 269 */ 270 271 extern int client_handler(void *cif_handler, void *arg_array); 272 273 /* 274 * The 'format' of the "translations" property in the 'mmu' node ... 275 */ 276 277 struct translation { 278 uint32_t virt_hi; /* upper 32 bits of vaddr */ 279 uint32_t virt_lo; /* lower 32 bits of vaddr */ 280 uint32_t size_hi; /* upper 32 bits of size in bytes */ 281 uint32_t size_lo; /* lower 32 bits of size in bytes */ 282 uint32_t tte_hi; /* higher 32 bites of tte */ 283 uint32_t tte_lo; /* lower 32 bits of tte */ 284 }; 285 286 #ifdef __cplusplus 287 } 288 #endif 289 290 #endif /* _SYS_PROM_PLAT_H */ 291