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