1*cefc7ca4SErik Kaneda // SPDX-License-Identifier: GPL-2.0-only 2*cefc7ca4SErik Kaneda /* 3*cefc7ca4SErik Kaneda * Author: Erik Kaneda <erik.kaneda@intel.com> 4*cefc7ca4SErik Kaneda * Copyright 2020 Intel Corporation 5*cefc7ca4SErik Kaneda * 6*cefc7ca4SErik Kaneda * prmt.c 7*cefc7ca4SErik Kaneda * 8*cefc7ca4SErik Kaneda * Each PRM service is an executable that is run in a restricted environment 9*cefc7ca4SErik Kaneda * that is invoked by writing to the PlatformRtMechanism OperationRegion from 10*cefc7ca4SErik Kaneda * AML bytecode. 11*cefc7ca4SErik Kaneda * 12*cefc7ca4SErik Kaneda * init_prmt initializes the Platform Runtime Mechanism (PRM) services by 13*cefc7ca4SErik Kaneda * processing data in the PRMT as well as registering an ACPI OperationRegion 14*cefc7ca4SErik Kaneda * handler for the PlatformRtMechanism subtype. 15*cefc7ca4SErik Kaneda * 16*cefc7ca4SErik Kaneda */ 17*cefc7ca4SErik Kaneda #include <linux/kernel.h> 18*cefc7ca4SErik Kaneda #include <linux/efi.h> 19*cefc7ca4SErik Kaneda #include <linux/acpi.h> 20*cefc7ca4SErik Kaneda #include <linux/prmt.h> 21*cefc7ca4SErik Kaneda #include <asm/efi.h> 22*cefc7ca4SErik Kaneda 23*cefc7ca4SErik Kaneda #pragma pack(1) 24*cefc7ca4SErik Kaneda struct prm_mmio_addr_range { 25*cefc7ca4SErik Kaneda u64 phys_addr; 26*cefc7ca4SErik Kaneda u64 virt_addr; 27*cefc7ca4SErik Kaneda u32 length; 28*cefc7ca4SErik Kaneda }; 29*cefc7ca4SErik Kaneda 30*cefc7ca4SErik Kaneda struct prm_mmio_info { 31*cefc7ca4SErik Kaneda u64 mmio_count; 32*cefc7ca4SErik Kaneda struct prm_mmio_addr_range addr_ranges[]; 33*cefc7ca4SErik Kaneda }; 34*cefc7ca4SErik Kaneda 35*cefc7ca4SErik Kaneda struct prm_buffer { 36*cefc7ca4SErik Kaneda u8 prm_status; 37*cefc7ca4SErik Kaneda u64 efi_status; 38*cefc7ca4SErik Kaneda u8 prm_cmd; 39*cefc7ca4SErik Kaneda guid_t handler_guid; 40*cefc7ca4SErik Kaneda }; 41*cefc7ca4SErik Kaneda 42*cefc7ca4SErik Kaneda struct prm_context_buffer { 43*cefc7ca4SErik Kaneda char signature[ACPI_NAMESEG_SIZE]; 44*cefc7ca4SErik Kaneda u16 revision; 45*cefc7ca4SErik Kaneda u16 reserved; 46*cefc7ca4SErik Kaneda guid_t identifier; 47*cefc7ca4SErik Kaneda u64 static_data_buffer; 48*cefc7ca4SErik Kaneda struct prm_mmio_info *mmio_ranges; 49*cefc7ca4SErik Kaneda }; 50*cefc7ca4SErik Kaneda #pragma pack() 51*cefc7ca4SErik Kaneda 52*cefc7ca4SErik Kaneda 53*cefc7ca4SErik Kaneda LIST_HEAD(prm_module_list); 54*cefc7ca4SErik Kaneda 55*cefc7ca4SErik Kaneda struct prm_handler_info { 56*cefc7ca4SErik Kaneda guid_t guid; 57*cefc7ca4SErik Kaneda u64 handler_addr; 58*cefc7ca4SErik Kaneda u64 static_data_buffer_addr; 59*cefc7ca4SErik Kaneda u64 acpi_param_buffer_addr; 60*cefc7ca4SErik Kaneda 61*cefc7ca4SErik Kaneda struct list_head handler_list; 62*cefc7ca4SErik Kaneda }; 63*cefc7ca4SErik Kaneda 64*cefc7ca4SErik Kaneda struct prm_module_info { 65*cefc7ca4SErik Kaneda guid_t guid; 66*cefc7ca4SErik Kaneda u16 major_rev; 67*cefc7ca4SErik Kaneda u16 minor_rev; 68*cefc7ca4SErik Kaneda u16 handler_count; 69*cefc7ca4SErik Kaneda struct prm_mmio_info *mmio_info; 70*cefc7ca4SErik Kaneda bool updatable; 71*cefc7ca4SErik Kaneda 72*cefc7ca4SErik Kaneda struct list_head module_list; 73*cefc7ca4SErik Kaneda struct prm_handler_info handlers[]; 74*cefc7ca4SErik Kaneda }; 75*cefc7ca4SErik Kaneda 76*cefc7ca4SErik Kaneda 77*cefc7ca4SErik Kaneda static u64 efi_pa_va_lookup(u64 pa) 78*cefc7ca4SErik Kaneda { 79*cefc7ca4SErik Kaneda efi_memory_desc_t *md; 80*cefc7ca4SErik Kaneda u64 pa_offset = pa & ~PAGE_MASK; 81*cefc7ca4SErik Kaneda u64 page = pa & PAGE_MASK; 82*cefc7ca4SErik Kaneda 83*cefc7ca4SErik Kaneda for_each_efi_memory_desc(md) { 84*cefc7ca4SErik Kaneda if (md->phys_addr < pa && pa < md->phys_addr + PAGE_SIZE * md->num_pages) 85*cefc7ca4SErik Kaneda return pa_offset + md->virt_addr + page - md->phys_addr; 86*cefc7ca4SErik Kaneda } 87*cefc7ca4SErik Kaneda 88*cefc7ca4SErik Kaneda return 0; 89*cefc7ca4SErik Kaneda } 90*cefc7ca4SErik Kaneda 91*cefc7ca4SErik Kaneda 92*cefc7ca4SErik Kaneda #define get_first_handler(a) ((struct acpi_prmt_handler_info *) ((char *) (a) + a->handler_info_offset)) 93*cefc7ca4SErik Kaneda #define get_next_handler(a) ((struct acpi_prmt_handler_info *) (sizeof(struct acpi_prmt_handler_info) + (char *) a)) 94*cefc7ca4SErik Kaneda 95*cefc7ca4SErik Kaneda static int __init 96*cefc7ca4SErik Kaneda acpi_parse_prmt(union acpi_subtable_headers *header, const unsigned long end) 97*cefc7ca4SErik Kaneda { 98*cefc7ca4SErik Kaneda struct acpi_prmt_module_info *module_info; 99*cefc7ca4SErik Kaneda struct acpi_prmt_handler_info *handler_info; 100*cefc7ca4SErik Kaneda struct prm_handler_info *th; 101*cefc7ca4SErik Kaneda struct prm_module_info *tm; 102*cefc7ca4SErik Kaneda u64 mmio_count = 0; 103*cefc7ca4SErik Kaneda u64 cur_handler = 0; 104*cefc7ca4SErik Kaneda u32 module_info_size = 0; 105*cefc7ca4SErik Kaneda u64 mmio_range_size = 0; 106*cefc7ca4SErik Kaneda void *temp_mmio; 107*cefc7ca4SErik Kaneda 108*cefc7ca4SErik Kaneda module_info = (struct acpi_prmt_module_info *) header; 109*cefc7ca4SErik Kaneda module_info_size = struct_size(tm, handlers, module_info->handler_info_count); 110*cefc7ca4SErik Kaneda tm = kmalloc(module_info_size, GFP_KERNEL); 111*cefc7ca4SErik Kaneda 112*cefc7ca4SErik Kaneda guid_copy(&tm->guid, (guid_t *) module_info->module_guid); 113*cefc7ca4SErik Kaneda tm->major_rev = module_info->major_rev; 114*cefc7ca4SErik Kaneda tm->minor_rev = module_info->minor_rev; 115*cefc7ca4SErik Kaneda tm->handler_count = module_info->handler_info_count; 116*cefc7ca4SErik Kaneda tm->updatable = true; 117*cefc7ca4SErik Kaneda 118*cefc7ca4SErik Kaneda if (module_info->mmio_list_pointer) { 119*cefc7ca4SErik Kaneda /* 120*cefc7ca4SErik Kaneda * Each module is associated with a list of addr 121*cefc7ca4SErik Kaneda * ranges that it can use during the service 122*cefc7ca4SErik Kaneda */ 123*cefc7ca4SErik Kaneda mmio_count = *(u64 *) memremap(module_info->mmio_list_pointer, 8, MEMREMAP_WB); 124*cefc7ca4SErik Kaneda mmio_range_size = struct_size(tm->mmio_info, addr_ranges, mmio_count); 125*cefc7ca4SErik Kaneda tm->mmio_info = kmalloc(mmio_range_size, GFP_KERNEL); 126*cefc7ca4SErik Kaneda temp_mmio = memremap(module_info->mmio_list_pointer, mmio_range_size, MEMREMAP_WB); 127*cefc7ca4SErik Kaneda memmove(tm->mmio_info, temp_mmio, mmio_range_size); 128*cefc7ca4SErik Kaneda } else { 129*cefc7ca4SErik Kaneda mmio_range_size = struct_size(tm->mmio_info, addr_ranges, mmio_count); 130*cefc7ca4SErik Kaneda tm->mmio_info = kmalloc(mmio_range_size, GFP_KERNEL); 131*cefc7ca4SErik Kaneda tm->mmio_info->mmio_count = 0; 132*cefc7ca4SErik Kaneda } 133*cefc7ca4SErik Kaneda 134*cefc7ca4SErik Kaneda INIT_LIST_HEAD(&tm->module_list); 135*cefc7ca4SErik Kaneda list_add(&tm->module_list, &prm_module_list); 136*cefc7ca4SErik Kaneda 137*cefc7ca4SErik Kaneda handler_info = get_first_handler(module_info); 138*cefc7ca4SErik Kaneda do { 139*cefc7ca4SErik Kaneda th = &tm->handlers[cur_handler]; 140*cefc7ca4SErik Kaneda 141*cefc7ca4SErik Kaneda guid_copy(&th->guid, (guid_t *)handler_info->handler_guid); 142*cefc7ca4SErik Kaneda th->handler_addr = efi_pa_va_lookup(handler_info->handler_address); 143*cefc7ca4SErik Kaneda th->static_data_buffer_addr = efi_pa_va_lookup(handler_info->static_data_buffer_address); 144*cefc7ca4SErik Kaneda th->acpi_param_buffer_addr = efi_pa_va_lookup(handler_info->acpi_param_buffer_address); 145*cefc7ca4SErik Kaneda } while (++cur_handler < tm->handler_count && (handler_info = get_next_handler(handler_info))); 146*cefc7ca4SErik Kaneda 147*cefc7ca4SErik Kaneda return 0; 148*cefc7ca4SErik Kaneda } 149*cefc7ca4SErik Kaneda 150*cefc7ca4SErik Kaneda #define GET_MODULE 0 151*cefc7ca4SErik Kaneda #define GET_HANDLER 1 152*cefc7ca4SErik Kaneda 153*cefc7ca4SErik Kaneda static void *find_guid_info(const guid_t *guid, u8 mode) 154*cefc7ca4SErik Kaneda { 155*cefc7ca4SErik Kaneda struct prm_handler_info *cur_handler; 156*cefc7ca4SErik Kaneda struct prm_module_info *cur_module; 157*cefc7ca4SErik Kaneda int i = 0; 158*cefc7ca4SErik Kaneda 159*cefc7ca4SErik Kaneda list_for_each_entry(cur_module, &prm_module_list, module_list) { 160*cefc7ca4SErik Kaneda for (i = 0; i < cur_module->handler_count; ++i) { 161*cefc7ca4SErik Kaneda cur_handler = &cur_module->handlers[i]; 162*cefc7ca4SErik Kaneda if (guid_equal(guid, &cur_handler->guid)) { 163*cefc7ca4SErik Kaneda if (mode == GET_MODULE) 164*cefc7ca4SErik Kaneda return (void *)cur_module; 165*cefc7ca4SErik Kaneda else 166*cefc7ca4SErik Kaneda return (void *)cur_handler; 167*cefc7ca4SErik Kaneda } 168*cefc7ca4SErik Kaneda } 169*cefc7ca4SErik Kaneda } 170*cefc7ca4SErik Kaneda 171*cefc7ca4SErik Kaneda return NULL; 172*cefc7ca4SErik Kaneda } 173*cefc7ca4SErik Kaneda 174*cefc7ca4SErik Kaneda 175*cefc7ca4SErik Kaneda static struct prm_module_info *find_prm_module(const guid_t *guid) 176*cefc7ca4SErik Kaneda { 177*cefc7ca4SErik Kaneda return (struct prm_module_info *)find_guid_info(guid, GET_MODULE); 178*cefc7ca4SErik Kaneda } 179*cefc7ca4SErik Kaneda 180*cefc7ca4SErik Kaneda static struct prm_handler_info *find_prm_handler(const guid_t *guid) 181*cefc7ca4SErik Kaneda { 182*cefc7ca4SErik Kaneda return (struct prm_handler_info *) find_guid_info(guid, GET_HANDLER); 183*cefc7ca4SErik Kaneda } 184*cefc7ca4SErik Kaneda 185*cefc7ca4SErik Kaneda /* In-coming PRM commands */ 186*cefc7ca4SErik Kaneda 187*cefc7ca4SErik Kaneda #define PRM_CMD_RUN_SERVICE 0 188*cefc7ca4SErik Kaneda #define PRM_CMD_START_TRANSACTION 1 189*cefc7ca4SErik Kaneda #define PRM_CMD_END_TRANSACTION 2 190*cefc7ca4SErik Kaneda 191*cefc7ca4SErik Kaneda /* statuses that can be passed back to ASL */ 192*cefc7ca4SErik Kaneda 193*cefc7ca4SErik Kaneda #define PRM_HANDLER_SUCCESS 0 194*cefc7ca4SErik Kaneda #define PRM_HANDLER_ERROR 1 195*cefc7ca4SErik Kaneda #define INVALID_PRM_COMMAND 2 196*cefc7ca4SErik Kaneda #define PRM_HANDLER_GUID_NOT_FOUND 3 197*cefc7ca4SErik Kaneda #define UPDATE_LOCK_ALREADY_HELD 4 198*cefc7ca4SErik Kaneda #define UPDATE_UNLOCK_WITHOUT_LOCK 5 199*cefc7ca4SErik Kaneda 200*cefc7ca4SErik Kaneda /* 201*cefc7ca4SErik Kaneda * This is the PlatformRtMechanism opregion space handler. 202*cefc7ca4SErik Kaneda * @function: indicates the read/write. In fact as the PlatformRtMechanism 203*cefc7ca4SErik Kaneda * message is driven by command, only write is meaningful. 204*cefc7ca4SErik Kaneda * 205*cefc7ca4SErik Kaneda * @addr : not used 206*cefc7ca4SErik Kaneda * @bits : not used. 207*cefc7ca4SErik Kaneda * @value : it is an in/out parameter. It points to the PRM message buffer. 208*cefc7ca4SErik Kaneda * @handler_context: not used 209*cefc7ca4SErik Kaneda */ 210*cefc7ca4SErik Kaneda static acpi_status acpi_platformrt_space_handler(u32 function, 211*cefc7ca4SErik Kaneda acpi_physical_address addr, 212*cefc7ca4SErik Kaneda u32 bits, acpi_integer *value, 213*cefc7ca4SErik Kaneda void *handler_context, 214*cefc7ca4SErik Kaneda void *region_context) 215*cefc7ca4SErik Kaneda { 216*cefc7ca4SErik Kaneda struct prm_buffer *buffer = ACPI_CAST_PTR(struct prm_buffer, value); 217*cefc7ca4SErik Kaneda struct prm_handler_info *handler; 218*cefc7ca4SErik Kaneda struct prm_module_info *module; 219*cefc7ca4SErik Kaneda efi_status_t status; 220*cefc7ca4SErik Kaneda struct prm_context_buffer context; 221*cefc7ca4SErik Kaneda 222*cefc7ca4SErik Kaneda /* 223*cefc7ca4SErik Kaneda * The returned acpi_status will always be AE_OK. Error values will be 224*cefc7ca4SErik Kaneda * saved in the first byte of the PRM message buffer to be used by ASL. 225*cefc7ca4SErik Kaneda */ 226*cefc7ca4SErik Kaneda switch (buffer->prm_cmd) { 227*cefc7ca4SErik Kaneda case PRM_CMD_RUN_SERVICE: 228*cefc7ca4SErik Kaneda 229*cefc7ca4SErik Kaneda handler = find_prm_handler(&buffer->handler_guid); 230*cefc7ca4SErik Kaneda module = find_prm_module(&buffer->handler_guid); 231*cefc7ca4SErik Kaneda if (!handler || !module) 232*cefc7ca4SErik Kaneda goto invalid_guid; 233*cefc7ca4SErik Kaneda 234*cefc7ca4SErik Kaneda ACPI_COPY_NAMESEG(context.signature, "PRMC"); 235*cefc7ca4SErik Kaneda context.revision = 0x0; 236*cefc7ca4SErik Kaneda context.reserved = 0x0; 237*cefc7ca4SErik Kaneda context.identifier = handler->guid; 238*cefc7ca4SErik Kaneda context.static_data_buffer = handler->static_data_buffer_addr; 239*cefc7ca4SErik Kaneda context.mmio_ranges = module->mmio_info; 240*cefc7ca4SErik Kaneda 241*cefc7ca4SErik Kaneda status = efi_call_virt_pointer(handler, handler_addr, 242*cefc7ca4SErik Kaneda handler->acpi_param_buffer_addr, 243*cefc7ca4SErik Kaneda &context); 244*cefc7ca4SErik Kaneda if (status == EFI_SUCCESS) { 245*cefc7ca4SErik Kaneda buffer->prm_status = PRM_HANDLER_SUCCESS; 246*cefc7ca4SErik Kaneda } else { 247*cefc7ca4SErik Kaneda buffer->prm_status = PRM_HANDLER_ERROR; 248*cefc7ca4SErik Kaneda buffer->efi_status = status; 249*cefc7ca4SErik Kaneda } 250*cefc7ca4SErik Kaneda break; 251*cefc7ca4SErik Kaneda 252*cefc7ca4SErik Kaneda case PRM_CMD_START_TRANSACTION: 253*cefc7ca4SErik Kaneda 254*cefc7ca4SErik Kaneda module = find_prm_module(&buffer->handler_guid); 255*cefc7ca4SErik Kaneda if (!module) 256*cefc7ca4SErik Kaneda goto invalid_guid; 257*cefc7ca4SErik Kaneda 258*cefc7ca4SErik Kaneda if (module->updatable) 259*cefc7ca4SErik Kaneda module->updatable = false; 260*cefc7ca4SErik Kaneda else 261*cefc7ca4SErik Kaneda buffer->prm_status = UPDATE_LOCK_ALREADY_HELD; 262*cefc7ca4SErik Kaneda break; 263*cefc7ca4SErik Kaneda 264*cefc7ca4SErik Kaneda case PRM_CMD_END_TRANSACTION: 265*cefc7ca4SErik Kaneda 266*cefc7ca4SErik Kaneda module = find_prm_module(&buffer->handler_guid); 267*cefc7ca4SErik Kaneda if (!module) 268*cefc7ca4SErik Kaneda goto invalid_guid; 269*cefc7ca4SErik Kaneda 270*cefc7ca4SErik Kaneda if (module->updatable) 271*cefc7ca4SErik Kaneda buffer->prm_status = UPDATE_UNLOCK_WITHOUT_LOCK; 272*cefc7ca4SErik Kaneda else 273*cefc7ca4SErik Kaneda module->updatable = true; 274*cefc7ca4SErik Kaneda break; 275*cefc7ca4SErik Kaneda 276*cefc7ca4SErik Kaneda default: 277*cefc7ca4SErik Kaneda 278*cefc7ca4SErik Kaneda buffer->prm_status = INVALID_PRM_COMMAND; 279*cefc7ca4SErik Kaneda break; 280*cefc7ca4SErik Kaneda } 281*cefc7ca4SErik Kaneda 282*cefc7ca4SErik Kaneda return AE_OK; 283*cefc7ca4SErik Kaneda 284*cefc7ca4SErik Kaneda invalid_guid: 285*cefc7ca4SErik Kaneda buffer->prm_status = PRM_HANDLER_GUID_NOT_FOUND; 286*cefc7ca4SErik Kaneda return AE_OK; 287*cefc7ca4SErik Kaneda } 288*cefc7ca4SErik Kaneda 289*cefc7ca4SErik Kaneda void __init init_prmt(void) 290*cefc7ca4SErik Kaneda { 291*cefc7ca4SErik Kaneda acpi_status status; 292*cefc7ca4SErik Kaneda int mc = acpi_table_parse_entries(ACPI_SIG_PRMT, sizeof(struct acpi_table_prmt) + 293*cefc7ca4SErik Kaneda sizeof (struct acpi_table_prmt_header), 294*cefc7ca4SErik Kaneda 0, acpi_parse_prmt, 0); 295*cefc7ca4SErik Kaneda pr_info("PRM: found %u modules\n", mc); 296*cefc7ca4SErik Kaneda 297*cefc7ca4SErik Kaneda status = acpi_install_address_space_handler(ACPI_ROOT_OBJECT, 298*cefc7ca4SErik Kaneda ACPI_ADR_SPACE_PLATFORM_RT, 299*cefc7ca4SErik Kaneda &acpi_platformrt_space_handler, 300*cefc7ca4SErik Kaneda NULL, NULL); 301*cefc7ca4SErik Kaneda if (ACPI_FAILURE(status)) 302*cefc7ca4SErik Kaneda pr_alert("PRM: OperationRegion handler could not be installed\n"); 303*cefc7ca4SErik Kaneda } 304