14faf31b4SDan Williams // SPDX-License-Identifier: GPL-2.0-only 24faf31b4SDan Williams /* Copyright(c) 2020 Intel Corporation. All rights reserved. */ 34faf31b4SDan Williams #include <linux/security.h> 44faf31b4SDan Williams #include <linux/debugfs.h> 5fa884345SJonathan Cameron #include <linux/ktime.h> 64faf31b4SDan Williams #include <linux/mutex.h> 7ed83f7caSAlison Schofield #include <asm/unaligned.h> 8d0abf578SAlison Schofield #include <cxlpci.h> 94faf31b4SDan Williams #include <cxlmem.h> 104faf31b4SDan Williams #include <cxl.h> 114faf31b4SDan Williams 124faf31b4SDan Williams #include "core.h" 136ebe28f9SIra Weiny #include "trace.h" 144faf31b4SDan Williams 154faf31b4SDan Williams static bool cxl_raw_allow_all; 164faf31b4SDan Williams 174faf31b4SDan Williams /** 184faf31b4SDan Williams * DOC: cxl mbox 194faf31b4SDan Williams * 204faf31b4SDan Williams * Core implementation of the CXL 2.0 Type-3 Memory Device Mailbox. The 214faf31b4SDan Williams * implementation is used by the cxl_pci driver to initialize the device 224faf31b4SDan Williams * and implement the cxl_mem.h IOCTL UAPI. It also implements the 234faf31b4SDan Williams * backend of the cxl_pmem_ctl() transport for LIBNVDIMM. 244faf31b4SDan Williams */ 254faf31b4SDan Williams 264faf31b4SDan Williams #define cxl_for_each_cmd(cmd) \ 274faf31b4SDan Williams for ((cmd) = &cxl_mem_commands[0]; \ 284faf31b4SDan Williams ((cmd) - cxl_mem_commands) < ARRAY_SIZE(cxl_mem_commands); (cmd)++) 294faf31b4SDan Williams 304faf31b4SDan Williams #define CXL_CMD(_id, sin, sout, _flags) \ 314faf31b4SDan Williams [CXL_MEM_COMMAND_ID_##_id] = { \ 324faf31b4SDan Williams .info = { \ 334faf31b4SDan Williams .id = CXL_MEM_COMMAND_ID_##_id, \ 344faf31b4SDan Williams .size_in = sin, \ 354faf31b4SDan Williams .size_out = sout, \ 364faf31b4SDan Williams }, \ 374faf31b4SDan Williams .opcode = CXL_MBOX_OP_##_id, \ 384faf31b4SDan Williams .flags = _flags, \ 394faf31b4SDan Williams } 404faf31b4SDan Williams 4126f89535SAlison Schofield #define CXL_VARIABLE_PAYLOAD ~0U 424faf31b4SDan Williams /* 434faf31b4SDan Williams * This table defines the supported mailbox commands for the driver. This table 444faf31b4SDan Williams * is made up of a UAPI structure. Non-negative values as parameters in the 454faf31b4SDan Williams * table will be validated against the user's input. For example, if size_in is 464faf31b4SDan Williams * 0, and the user passed in 1, it is an error. 474faf31b4SDan Williams */ 484faf31b4SDan Williams static struct cxl_mem_command cxl_mem_commands[CXL_MEM_COMMAND_ID_MAX] = { 494faf31b4SDan Williams CXL_CMD(IDENTIFY, 0, 0x43, CXL_CMD_FLAG_FORCE_ENABLE), 504faf31b4SDan Williams #ifdef CONFIG_CXL_MEM_RAW_COMMANDS 5126f89535SAlison Schofield CXL_CMD(RAW, CXL_VARIABLE_PAYLOAD, CXL_VARIABLE_PAYLOAD, 0), 524faf31b4SDan Williams #endif 5326f89535SAlison Schofield CXL_CMD(GET_SUPPORTED_LOGS, 0, CXL_VARIABLE_PAYLOAD, CXL_CMD_FLAG_FORCE_ENABLE), 544faf31b4SDan Williams CXL_CMD(GET_FW_INFO, 0, 0x50, 0), 554faf31b4SDan Williams CXL_CMD(GET_PARTITION_INFO, 0, 0x20, 0), 5626f89535SAlison Schofield CXL_CMD(GET_LSA, 0x8, CXL_VARIABLE_PAYLOAD, 0), 574faf31b4SDan Williams CXL_CMD(GET_HEALTH_INFO, 0, 0x12, 0), 5826f89535SAlison Schofield CXL_CMD(GET_LOG, 0x18, CXL_VARIABLE_PAYLOAD, CXL_CMD_FLAG_FORCE_ENABLE), 59940325adSSrinivasulu Thanneeru CXL_CMD(GET_LOG_CAPS, 0x10, 0x4, 0), 60*206f9fa9SSrinivasulu Thanneeru CXL_CMD(CLEAR_LOG, 0x10, 0, 0), 61940325adSSrinivasulu Thanneeru CXL_CMD(GET_SUP_LOG_SUBLIST, 0x2, CXL_VARIABLE_PAYLOAD, 0), 624faf31b4SDan Williams CXL_CMD(SET_PARTITION_INFO, 0x0a, 0, 0), 6326f89535SAlison Schofield CXL_CMD(SET_LSA, CXL_VARIABLE_PAYLOAD, 0, 0), 644faf31b4SDan Williams CXL_CMD(GET_ALERT_CONFIG, 0, 0x10, 0), 654faf31b4SDan Williams CXL_CMD(SET_ALERT_CONFIG, 0xc, 0, 0), 664faf31b4SDan Williams CXL_CMD(GET_SHUTDOWN_STATE, 0, 0x1, 0), 674faf31b4SDan Williams CXL_CMD(SET_SHUTDOWN_STATE, 0x1, 0, 0), 684faf31b4SDan Williams CXL_CMD(GET_SCAN_MEDIA_CAPS, 0x10, 0x4, 0), 69cb46fca8SDavidlohr Bueso CXL_CMD(GET_TIMESTAMP, 0, 0x8, 0), 704faf31b4SDan Williams }; 714faf31b4SDan Williams 724faf31b4SDan Williams /* 734faf31b4SDan Williams * Commands that RAW doesn't permit. The rationale for each: 744faf31b4SDan Williams * 754faf31b4SDan Williams * CXL_MBOX_OP_ACTIVATE_FW: Firmware activation requires adjustment / 764faf31b4SDan Williams * coordination of transaction timeout values at the root bridge level. 774faf31b4SDan Williams * 784faf31b4SDan Williams * CXL_MBOX_OP_SET_PARTITION_INFO: The device memory map may change live 794faf31b4SDan Williams * and needs to be coordinated with HDM updates. 804faf31b4SDan Williams * 814faf31b4SDan Williams * CXL_MBOX_OP_SET_LSA: The label storage area may be cached by the 824faf31b4SDan Williams * driver and any writes from userspace invalidates those contents. 834faf31b4SDan Williams * 844faf31b4SDan Williams * CXL_MBOX_OP_SET_SHUTDOWN_STATE: Set shutdown state assumes no writes 854faf31b4SDan Williams * to the device after it is marked clean, userspace can not make that 864faf31b4SDan Williams * assertion. 874faf31b4SDan Williams * 884faf31b4SDan Williams * CXL_MBOX_OP_[GET_]SCAN_MEDIA: The kernel provides a native error list that 894faf31b4SDan Williams * is kept up to date with patrol notifications and error management. 90dec441d3SAlison Schofield * 91dec441d3SAlison Schofield * CXL_MBOX_OP_[GET_,INJECT_,CLEAR_]POISON: These commands require kernel 92dec441d3SAlison Schofield * driver orchestration for safety. 934faf31b4SDan Williams */ 944faf31b4SDan Williams static u16 cxl_disabled_raw_commands[] = { 954faf31b4SDan Williams CXL_MBOX_OP_ACTIVATE_FW, 964faf31b4SDan Williams CXL_MBOX_OP_SET_PARTITION_INFO, 974faf31b4SDan Williams CXL_MBOX_OP_SET_LSA, 984faf31b4SDan Williams CXL_MBOX_OP_SET_SHUTDOWN_STATE, 994faf31b4SDan Williams CXL_MBOX_OP_SCAN_MEDIA, 1004faf31b4SDan Williams CXL_MBOX_OP_GET_SCAN_MEDIA, 101dec441d3SAlison Schofield CXL_MBOX_OP_GET_POISON, 102dec441d3SAlison Schofield CXL_MBOX_OP_INJECT_POISON, 103dec441d3SAlison Schofield CXL_MBOX_OP_CLEAR_POISON, 1044faf31b4SDan Williams }; 1054faf31b4SDan Williams 1064faf31b4SDan Williams /* 1074faf31b4SDan Williams * Command sets that RAW doesn't permit. All opcodes in this set are 1084faf31b4SDan Williams * disabled because they pass plain text security payloads over the 1094faf31b4SDan Williams * user/kernel boundary. This functionality is intended to be wrapped 1104faf31b4SDan Williams * behind the keys ABI which allows for encrypted payloads in the UAPI 1114faf31b4SDan Williams */ 1124faf31b4SDan Williams static u8 security_command_sets[] = { 1134faf31b4SDan Williams 0x44, /* Sanitize */ 1144faf31b4SDan Williams 0x45, /* Persistent Memory Data-at-rest Security */ 1154faf31b4SDan Williams 0x46, /* Security Passthrough */ 1164faf31b4SDan Williams }; 1174faf31b4SDan Williams 1184faf31b4SDan Williams static bool cxl_is_security_command(u16 opcode) 1194faf31b4SDan Williams { 1204faf31b4SDan Williams int i; 1214faf31b4SDan Williams 1224faf31b4SDan Williams for (i = 0; i < ARRAY_SIZE(security_command_sets); i++) 1234faf31b4SDan Williams if (security_command_sets[i] == (opcode >> 8)) 1244faf31b4SDan Williams return true; 1254faf31b4SDan Williams return false; 1264faf31b4SDan Williams } 1274faf31b4SDan Williams 128ad64f595SDavidlohr Bueso static void cxl_set_security_cmd_enabled(struct cxl_security_state *security, 129ad64f595SDavidlohr Bueso u16 opcode) 130ad64f595SDavidlohr Bueso { 131ad64f595SDavidlohr Bueso switch (opcode) { 132ad64f595SDavidlohr Bueso case CXL_MBOX_OP_SANITIZE: 133ad64f595SDavidlohr Bueso set_bit(CXL_SEC_ENABLED_SANITIZE, security->enabled_cmds); 134ad64f595SDavidlohr Bueso break; 135ad64f595SDavidlohr Bueso case CXL_MBOX_OP_SECURE_ERASE: 136ad64f595SDavidlohr Bueso set_bit(CXL_SEC_ENABLED_SECURE_ERASE, 137ad64f595SDavidlohr Bueso security->enabled_cmds); 138ad64f595SDavidlohr Bueso break; 139ad64f595SDavidlohr Bueso case CXL_MBOX_OP_GET_SECURITY_STATE: 140ad64f595SDavidlohr Bueso set_bit(CXL_SEC_ENABLED_GET_SECURITY_STATE, 141ad64f595SDavidlohr Bueso security->enabled_cmds); 142ad64f595SDavidlohr Bueso break; 143ad64f595SDavidlohr Bueso case CXL_MBOX_OP_SET_PASSPHRASE: 144ad64f595SDavidlohr Bueso set_bit(CXL_SEC_ENABLED_SET_PASSPHRASE, 145ad64f595SDavidlohr Bueso security->enabled_cmds); 146ad64f595SDavidlohr Bueso break; 147ad64f595SDavidlohr Bueso case CXL_MBOX_OP_DISABLE_PASSPHRASE: 148ad64f595SDavidlohr Bueso set_bit(CXL_SEC_ENABLED_DISABLE_PASSPHRASE, 149ad64f595SDavidlohr Bueso security->enabled_cmds); 150ad64f595SDavidlohr Bueso break; 151ad64f595SDavidlohr Bueso case CXL_MBOX_OP_UNLOCK: 152ad64f595SDavidlohr Bueso set_bit(CXL_SEC_ENABLED_UNLOCK, security->enabled_cmds); 153ad64f595SDavidlohr Bueso break; 154ad64f595SDavidlohr Bueso case CXL_MBOX_OP_FREEZE_SECURITY: 155ad64f595SDavidlohr Bueso set_bit(CXL_SEC_ENABLED_FREEZE_SECURITY, 156ad64f595SDavidlohr Bueso security->enabled_cmds); 157ad64f595SDavidlohr Bueso break; 158ad64f595SDavidlohr Bueso case CXL_MBOX_OP_PASSPHRASE_SECURE_ERASE: 159ad64f595SDavidlohr Bueso set_bit(CXL_SEC_ENABLED_PASSPHRASE_SECURE_ERASE, 160ad64f595SDavidlohr Bueso security->enabled_cmds); 161ad64f595SDavidlohr Bueso break; 162ad64f595SDavidlohr Bueso default: 163ad64f595SDavidlohr Bueso break; 164ad64f595SDavidlohr Bueso } 165ad64f595SDavidlohr Bueso } 166ad64f595SDavidlohr Bueso 167d0abf578SAlison Schofield static bool cxl_is_poison_command(u16 opcode) 168d0abf578SAlison Schofield { 169d0abf578SAlison Schofield #define CXL_MBOX_OP_POISON_CMDS 0x43 170d0abf578SAlison Schofield 171d0abf578SAlison Schofield if ((opcode >> 8) == CXL_MBOX_OP_POISON_CMDS) 172d0abf578SAlison Schofield return true; 173d0abf578SAlison Schofield 174d0abf578SAlison Schofield return false; 175d0abf578SAlison Schofield } 176d0abf578SAlison Schofield 177d0abf578SAlison Schofield static void cxl_set_poison_cmd_enabled(struct cxl_poison_state *poison, 178d0abf578SAlison Schofield u16 opcode) 179d0abf578SAlison Schofield { 180d0abf578SAlison Schofield switch (opcode) { 181d0abf578SAlison Schofield case CXL_MBOX_OP_GET_POISON: 182d0abf578SAlison Schofield set_bit(CXL_POISON_ENABLED_LIST, poison->enabled_cmds); 183d0abf578SAlison Schofield break; 184d0abf578SAlison Schofield case CXL_MBOX_OP_INJECT_POISON: 185d0abf578SAlison Schofield set_bit(CXL_POISON_ENABLED_INJECT, poison->enabled_cmds); 186d0abf578SAlison Schofield break; 187d0abf578SAlison Schofield case CXL_MBOX_OP_CLEAR_POISON: 188d0abf578SAlison Schofield set_bit(CXL_POISON_ENABLED_CLEAR, poison->enabled_cmds); 189d0abf578SAlison Schofield break; 190d0abf578SAlison Schofield case CXL_MBOX_OP_GET_SCAN_MEDIA_CAPS: 191d0abf578SAlison Schofield set_bit(CXL_POISON_ENABLED_SCAN_CAPS, poison->enabled_cmds); 192d0abf578SAlison Schofield break; 193d0abf578SAlison Schofield case CXL_MBOX_OP_SCAN_MEDIA: 194d0abf578SAlison Schofield set_bit(CXL_POISON_ENABLED_SCAN_MEDIA, poison->enabled_cmds); 195d0abf578SAlison Schofield break; 196d0abf578SAlison Schofield case CXL_MBOX_OP_GET_SCAN_MEDIA: 197d0abf578SAlison Schofield set_bit(CXL_POISON_ENABLED_SCAN_RESULTS, poison->enabled_cmds); 198d0abf578SAlison Schofield break; 199d0abf578SAlison Schofield default: 200d0abf578SAlison Schofield break; 201d0abf578SAlison Schofield } 202d0abf578SAlison Schofield } 203d0abf578SAlison Schofield 2044faf31b4SDan Williams static struct cxl_mem_command *cxl_mem_find_command(u16 opcode) 2054faf31b4SDan Williams { 2064faf31b4SDan Williams struct cxl_mem_command *c; 2074faf31b4SDan Williams 2084faf31b4SDan Williams cxl_for_each_cmd(c) 2094faf31b4SDan Williams if (c->opcode == opcode) 2104faf31b4SDan Williams return c; 2114faf31b4SDan Williams 2124faf31b4SDan Williams return NULL; 2134faf31b4SDan Williams } 2144faf31b4SDan Williams 21582b8ba29SAlison Schofield static const char *cxl_mem_opcode_to_name(u16 opcode) 21682b8ba29SAlison Schofield { 21782b8ba29SAlison Schofield struct cxl_mem_command *c; 21882b8ba29SAlison Schofield 21982b8ba29SAlison Schofield c = cxl_mem_find_command(opcode); 22082b8ba29SAlison Schofield if (!c) 22182b8ba29SAlison Schofield return NULL; 22282b8ba29SAlison Schofield 22382b8ba29SAlison Schofield return cxl_command_names[c->info.id].name; 22482b8ba29SAlison Schofield } 22582b8ba29SAlison Schofield 2264faf31b4SDan Williams /** 2275331cdf4SDan Williams * cxl_internal_send_cmd() - Kernel internal interface to send a mailbox command 22859f8d151SDan Williams * @mds: The driver data for the operation 2295331cdf4SDan Williams * @mbox_cmd: initialized command to execute 2304faf31b4SDan Williams * 231ee92c7e2SDavidlohr Bueso * Context: Any context. 2324faf31b4SDan Williams * Return: 2334faf31b4SDan Williams * * %>=0 - Number of bytes returned in @out. 2344faf31b4SDan Williams * * %-E2BIG - Payload is too large for hardware. 2354faf31b4SDan Williams * * %-EBUSY - Couldn't acquire exclusive mailbox access. 2364faf31b4SDan Williams * * %-EFAULT - Hardware error occurred. 2374faf31b4SDan Williams * * %-ENXIO - Command completed, but device reported an error. 2384faf31b4SDan Williams * * %-EIO - Unexpected output size. 2394faf31b4SDan Williams * 2404faf31b4SDan Williams * Mailbox commands may execute successfully yet the device itself reported an 2414faf31b4SDan Williams * error. While this distinction can be useful for commands from userspace, the 2424faf31b4SDan Williams * kernel will only be able to use results when both are successful. 2434faf31b4SDan Williams */ 24459f8d151SDan Williams int cxl_internal_send_cmd(struct cxl_memdev_state *mds, 2455331cdf4SDan Williams struct cxl_mbox_cmd *mbox_cmd) 2464faf31b4SDan Williams { 2472aeaf663SDan Williams size_t out_size, min_out; 2484faf31b4SDan Williams int rc; 2494faf31b4SDan Williams 25059f8d151SDan Williams if (mbox_cmd->size_in > mds->payload_size || 25159f8d151SDan Williams mbox_cmd->size_out > mds->payload_size) 2524faf31b4SDan Williams return -E2BIG; 2534faf31b4SDan Williams 2545331cdf4SDan Williams out_size = mbox_cmd->size_out; 2552aeaf663SDan Williams min_out = mbox_cmd->min_out; 25659f8d151SDan Williams rc = mds->mbox_send(mds, mbox_cmd); 257623c0751SRobert Richter /* 258623c0751SRobert Richter * EIO is reserved for a payload size mismatch and mbox_send() 259623c0751SRobert Richter * may not return this error. 260623c0751SRobert Richter */ 261623c0751SRobert Richter if (WARN_ONCE(rc == -EIO, "Bad return code: -EIO")) 262623c0751SRobert Richter return -ENXIO; 2634faf31b4SDan Williams if (rc) 2644faf31b4SDan Williams return rc; 2654faf31b4SDan Williams 266ccadf131SDavidlohr Bueso if (mbox_cmd->return_code != CXL_MBOX_CMD_RC_SUCCESS && 267ccadf131SDavidlohr Bueso mbox_cmd->return_code != CXL_MBOX_CMD_RC_BACKGROUND) 2685331cdf4SDan Williams return cxl_mbox_cmd_rc2errno(mbox_cmd); 2694faf31b4SDan Williams 2702aeaf663SDan Williams if (!out_size) 2712aeaf663SDan Williams return 0; 2722aeaf663SDan Williams 2734faf31b4SDan Williams /* 2742aeaf663SDan Williams * Variable sized output needs to at least satisfy the caller's 2752aeaf663SDan Williams * minimum if not the fully requested size. 2764faf31b4SDan Williams */ 2772aeaf663SDan Williams if (min_out == 0) 2782aeaf663SDan Williams min_out = out_size; 2792aeaf663SDan Williams 2802aeaf663SDan Williams if (mbox_cmd->size_out < min_out) 2814faf31b4SDan Williams return -EIO; 2824faf31b4SDan Williams return 0; 2834faf31b4SDan Williams } 2845331cdf4SDan Williams EXPORT_SYMBOL_NS_GPL(cxl_internal_send_cmd, CXL); 2854faf31b4SDan Williams 2864faf31b4SDan Williams static bool cxl_mem_raw_command_allowed(u16 opcode) 2874faf31b4SDan Williams { 2884faf31b4SDan Williams int i; 2894faf31b4SDan Williams 2904faf31b4SDan Williams if (!IS_ENABLED(CONFIG_CXL_MEM_RAW_COMMANDS)) 2914faf31b4SDan Williams return false; 2924faf31b4SDan Williams 2934faf31b4SDan Williams if (security_locked_down(LOCKDOWN_PCI_ACCESS)) 2944faf31b4SDan Williams return false; 2954faf31b4SDan Williams 2964faf31b4SDan Williams if (cxl_raw_allow_all) 2974faf31b4SDan Williams return true; 2984faf31b4SDan Williams 2994faf31b4SDan Williams if (cxl_is_security_command(opcode)) 3004faf31b4SDan Williams return false; 3014faf31b4SDan Williams 3024faf31b4SDan Williams for (i = 0; i < ARRAY_SIZE(cxl_disabled_raw_commands); i++) 3034faf31b4SDan Williams if (cxl_disabled_raw_commands[i] == opcode) 3044faf31b4SDan Williams return false; 3054faf31b4SDan Williams 3064faf31b4SDan Williams return true; 3074faf31b4SDan Williams } 3084faf31b4SDan Williams 3096179045cSAlison Schofield /** 3106179045cSAlison Schofield * cxl_payload_from_user_allowed() - Check contents of in_payload. 3116179045cSAlison Schofield * @opcode: The mailbox command opcode. 3126179045cSAlison Schofield * @payload_in: Pointer to the input payload passed in from user space. 3136179045cSAlison Schofield * 3146179045cSAlison Schofield * Return: 3156179045cSAlison Schofield * * true - payload_in passes check for @opcode. 3166179045cSAlison Schofield * * false - payload_in contains invalid or unsupported values. 3176179045cSAlison Schofield * 3186179045cSAlison Schofield * The driver may inspect payload contents before sending a mailbox 3196179045cSAlison Schofield * command from user space to the device. The intent is to reject 3206179045cSAlison Schofield * commands with input payloads that are known to be unsafe. This 3216179045cSAlison Schofield * check is not intended to replace the users careful selection of 3226179045cSAlison Schofield * mailbox command parameters and makes no guarantee that the user 3236179045cSAlison Schofield * command will succeed, nor that it is appropriate. 3246179045cSAlison Schofield * 3256179045cSAlison Schofield * The specific checks are determined by the opcode. 3266179045cSAlison Schofield */ 3276179045cSAlison Schofield static bool cxl_payload_from_user_allowed(u16 opcode, void *payload_in) 3286179045cSAlison Schofield { 3296179045cSAlison Schofield switch (opcode) { 3306179045cSAlison Schofield case CXL_MBOX_OP_SET_PARTITION_INFO: { 3316179045cSAlison Schofield struct cxl_mbox_set_partition_info *pi = payload_in; 3326179045cSAlison Schofield 33335e01667SDan Carpenter if (pi->flags & CXL_SET_PARTITION_IMMEDIATE_FLAG) 3346179045cSAlison Schofield return false; 3356179045cSAlison Schofield break; 3366179045cSAlison Schofield } 337*206f9fa9SSrinivasulu Thanneeru case CXL_MBOX_OP_CLEAR_LOG: { 338*206f9fa9SSrinivasulu Thanneeru const uuid_t *uuid = (uuid_t *)payload_in; 339*206f9fa9SSrinivasulu Thanneeru 340*206f9fa9SSrinivasulu Thanneeru /* 341*206f9fa9SSrinivasulu Thanneeru * Restrict the ‘Clear log’ action to only apply to 342*206f9fa9SSrinivasulu Thanneeru * Vendor debug logs. 343*206f9fa9SSrinivasulu Thanneeru */ 344*206f9fa9SSrinivasulu Thanneeru return uuid_equal(uuid, &DEFINE_CXL_VENDOR_DEBUG_UUID); 345*206f9fa9SSrinivasulu Thanneeru } 3466179045cSAlison Schofield default: 3476179045cSAlison Schofield break; 3486179045cSAlison Schofield } 3496179045cSAlison Schofield return true; 3506179045cSAlison Schofield } 3516179045cSAlison Schofield 35263cf60b7SAlison Schofield static int cxl_mbox_cmd_ctor(struct cxl_mbox_cmd *mbox, 35359f8d151SDan Williams struct cxl_memdev_state *mds, u16 opcode, 35463cf60b7SAlison Schofield size_t in_size, size_t out_size, u64 in_payload) 35563cf60b7SAlison Schofield { 35663cf60b7SAlison Schofield *mbox = (struct cxl_mbox_cmd) { 35763cf60b7SAlison Schofield .opcode = opcode, 35863cf60b7SAlison Schofield .size_in = in_size, 35963cf60b7SAlison Schofield }; 36063cf60b7SAlison Schofield 36163cf60b7SAlison Schofield if (in_size) { 36263cf60b7SAlison Schofield mbox->payload_in = vmemdup_user(u64_to_user_ptr(in_payload), 36363cf60b7SAlison Schofield in_size); 364280302f0SAlison Schofield if (IS_ERR(mbox->payload_in)) 36563cf60b7SAlison Schofield return PTR_ERR(mbox->payload_in); 3666179045cSAlison Schofield 3676179045cSAlison Schofield if (!cxl_payload_from_user_allowed(opcode, mbox->payload_in)) { 36859f8d151SDan Williams dev_dbg(mds->cxlds.dev, "%s: input payload not allowed\n", 3696179045cSAlison Schofield cxl_mem_opcode_to_name(opcode)); 3706179045cSAlison Schofield kvfree(mbox->payload_in); 3716179045cSAlison Schofield return -EBUSY; 3726179045cSAlison Schofield } 37363cf60b7SAlison Schofield } 37463cf60b7SAlison Schofield 37563cf60b7SAlison Schofield /* Prepare to handle a full payload for variable sized output */ 37626f89535SAlison Schofield if (out_size == CXL_VARIABLE_PAYLOAD) 37759f8d151SDan Williams mbox->size_out = mds->payload_size; 37863cf60b7SAlison Schofield else 37963cf60b7SAlison Schofield mbox->size_out = out_size; 38063cf60b7SAlison Schofield 38163cf60b7SAlison Schofield if (mbox->size_out) { 38263cf60b7SAlison Schofield mbox->payload_out = kvzalloc(mbox->size_out, GFP_KERNEL); 38363cf60b7SAlison Schofield if (!mbox->payload_out) { 38463cf60b7SAlison Schofield kvfree(mbox->payload_in); 38563cf60b7SAlison Schofield return -ENOMEM; 38663cf60b7SAlison Schofield } 38763cf60b7SAlison Schofield } 38863cf60b7SAlison Schofield return 0; 38963cf60b7SAlison Schofield } 39063cf60b7SAlison Schofield 39163cf60b7SAlison Schofield static void cxl_mbox_cmd_dtor(struct cxl_mbox_cmd *mbox) 39263cf60b7SAlison Schofield { 39363cf60b7SAlison Schofield kvfree(mbox->payload_in); 39463cf60b7SAlison Schofield kvfree(mbox->payload_out); 39563cf60b7SAlison Schofield } 39663cf60b7SAlison Schofield 3976dd0e5ccSAlison Schofield static int cxl_to_mem_cmd_raw(struct cxl_mem_command *mem_cmd, 3986dd0e5ccSAlison Schofield const struct cxl_send_command *send_cmd, 39959f8d151SDan Williams struct cxl_memdev_state *mds) 4006dd0e5ccSAlison Schofield { 4016dd0e5ccSAlison Schofield if (send_cmd->raw.rsvd) 4026dd0e5ccSAlison Schofield return -EINVAL; 4036dd0e5ccSAlison Schofield 4046dd0e5ccSAlison Schofield /* 4056dd0e5ccSAlison Schofield * Unlike supported commands, the output size of RAW commands 4066dd0e5ccSAlison Schofield * gets passed along without further checking, so it must be 4076dd0e5ccSAlison Schofield * validated here. 4086dd0e5ccSAlison Schofield */ 40959f8d151SDan Williams if (send_cmd->out.size > mds->payload_size) 4106dd0e5ccSAlison Schofield return -EINVAL; 4116dd0e5ccSAlison Schofield 4126dd0e5ccSAlison Schofield if (!cxl_mem_raw_command_allowed(send_cmd->raw.opcode)) 4136dd0e5ccSAlison Schofield return -EPERM; 4146dd0e5ccSAlison Schofield 41559f8d151SDan Williams dev_WARN_ONCE(mds->cxlds.dev, true, "raw command path used\n"); 41639ed8da4SAlison Schofield 4176dd0e5ccSAlison Schofield *mem_cmd = (struct cxl_mem_command) { 4186dd0e5ccSAlison Schofield .info = { 4196dd0e5ccSAlison Schofield .id = CXL_MEM_COMMAND_ID_RAW, 4206dd0e5ccSAlison Schofield .size_in = send_cmd->in.size, 4216dd0e5ccSAlison Schofield .size_out = send_cmd->out.size, 4226dd0e5ccSAlison Schofield }, 4236dd0e5ccSAlison Schofield .opcode = send_cmd->raw.opcode 4246dd0e5ccSAlison Schofield }; 4256dd0e5ccSAlison Schofield 4266dd0e5ccSAlison Schofield return 0; 4276dd0e5ccSAlison Schofield } 4286dd0e5ccSAlison Schofield 4296dd0e5ccSAlison Schofield static int cxl_to_mem_cmd(struct cxl_mem_command *mem_cmd, 4306dd0e5ccSAlison Schofield const struct cxl_send_command *send_cmd, 43159f8d151SDan Williams struct cxl_memdev_state *mds) 4326dd0e5ccSAlison Schofield { 4336dd0e5ccSAlison Schofield struct cxl_mem_command *c = &cxl_mem_commands[send_cmd->id]; 4346dd0e5ccSAlison Schofield const struct cxl_command_info *info = &c->info; 4356dd0e5ccSAlison Schofield 4366dd0e5ccSAlison Schofield if (send_cmd->flags & ~CXL_MEM_COMMAND_FLAG_MASK) 4376dd0e5ccSAlison Schofield return -EINVAL; 4386dd0e5ccSAlison Schofield 4396dd0e5ccSAlison Schofield if (send_cmd->rsvd) 4406dd0e5ccSAlison Schofield return -EINVAL; 4416dd0e5ccSAlison Schofield 4426dd0e5ccSAlison Schofield if (send_cmd->in.rsvd || send_cmd->out.rsvd) 4436dd0e5ccSAlison Schofield return -EINVAL; 4446dd0e5ccSAlison Schofield 4456dd0e5ccSAlison Schofield /* Check that the command is enabled for hardware */ 44659f8d151SDan Williams if (!test_bit(info->id, mds->enabled_cmds)) 4476dd0e5ccSAlison Schofield return -ENOTTY; 4486dd0e5ccSAlison Schofield 4496dd0e5ccSAlison Schofield /* Check that the command is not claimed for exclusive kernel use */ 45059f8d151SDan Williams if (test_bit(info->id, mds->exclusive_cmds)) 4516dd0e5ccSAlison Schofield return -EBUSY; 4526dd0e5ccSAlison Schofield 4536dd0e5ccSAlison Schofield /* Check the input buffer is the expected size */ 454e35f5718SVishal Verma if ((info->size_in != CXL_VARIABLE_PAYLOAD) && 455e35f5718SVishal Verma (info->size_in != send_cmd->in.size)) 4566dd0e5ccSAlison Schofield return -ENOMEM; 4576dd0e5ccSAlison Schofield 4586dd0e5ccSAlison Schofield /* Check the output buffer is at least large enough */ 459e35f5718SVishal Verma if ((info->size_out != CXL_VARIABLE_PAYLOAD) && 460e35f5718SVishal Verma (send_cmd->out.size < info->size_out)) 4616dd0e5ccSAlison Schofield return -ENOMEM; 4626dd0e5ccSAlison Schofield 4636dd0e5ccSAlison Schofield *mem_cmd = (struct cxl_mem_command) { 4646dd0e5ccSAlison Schofield .info = { 4656dd0e5ccSAlison Schofield .id = info->id, 4666dd0e5ccSAlison Schofield .flags = info->flags, 4676dd0e5ccSAlison Schofield .size_in = send_cmd->in.size, 4686dd0e5ccSAlison Schofield .size_out = send_cmd->out.size, 4696dd0e5ccSAlison Schofield }, 4706dd0e5ccSAlison Schofield .opcode = c->opcode 4716dd0e5ccSAlison Schofield }; 4726dd0e5ccSAlison Schofield 4736dd0e5ccSAlison Schofield return 0; 4746dd0e5ccSAlison Schofield } 4756dd0e5ccSAlison Schofield 4764faf31b4SDan Williams /** 4774faf31b4SDan Williams * cxl_validate_cmd_from_user() - Check fields for CXL_MEM_SEND_COMMAND. 4789ae016aeSAlison Schofield * @mbox_cmd: Sanitized and populated &struct cxl_mbox_cmd. 47959f8d151SDan Williams * @mds: The driver data for the operation 4804faf31b4SDan Williams * @send_cmd: &struct cxl_send_command copied in from userspace. 4814faf31b4SDan Williams * 4824faf31b4SDan Williams * Return: 4834faf31b4SDan Williams * * %0 - @out_cmd is ready to send. 4844faf31b4SDan Williams * * %-ENOTTY - Invalid command specified. 4854faf31b4SDan Williams * * %-EINVAL - Reserved fields or invalid values were used. 4864faf31b4SDan Williams * * %-ENOMEM - Input or output buffer wasn't sized properly. 4874faf31b4SDan Williams * * %-EPERM - Attempted to use a protected command. 48812f3856aSDan Williams * * %-EBUSY - Kernel has claimed exclusive access to this opcode 4894faf31b4SDan Williams * 4902dd5600aSAlison Schofield * The result of this command is a fully validated command in @mbox_cmd that is 4914faf31b4SDan Williams * safe to send to the hardware. 4924faf31b4SDan Williams */ 4939ae016aeSAlison Schofield static int cxl_validate_cmd_from_user(struct cxl_mbox_cmd *mbox_cmd, 49459f8d151SDan Williams struct cxl_memdev_state *mds, 4952dd5600aSAlison Schofield const struct cxl_send_command *send_cmd) 4964faf31b4SDan Williams { 4972dd5600aSAlison Schofield struct cxl_mem_command mem_cmd; 4989ae016aeSAlison Schofield int rc; 4999ae016aeSAlison Schofield 5004faf31b4SDan Williams if (send_cmd->id == 0 || send_cmd->id >= CXL_MEM_COMMAND_ID_MAX) 5014faf31b4SDan Williams return -ENOTTY; 5024faf31b4SDan Williams 5034faf31b4SDan Williams /* 5044faf31b4SDan Williams * The user can never specify an input payload larger than what hardware 5054faf31b4SDan Williams * supports, but output can be arbitrarily large (simply write out as 5064faf31b4SDan Williams * much data as the hardware provides). 5074faf31b4SDan Williams */ 50859f8d151SDan Williams if (send_cmd->in.size > mds->payload_size) 5094faf31b4SDan Williams return -EINVAL; 5104faf31b4SDan Williams 5116dd0e5ccSAlison Schofield /* Sanitize and construct a cxl_mem_command */ 5126dd0e5ccSAlison Schofield if (send_cmd->id == CXL_MEM_COMMAND_ID_RAW) 51359f8d151SDan Williams rc = cxl_to_mem_cmd_raw(&mem_cmd, send_cmd, mds); 5146dd0e5ccSAlison Schofield else 51559f8d151SDan Williams rc = cxl_to_mem_cmd(&mem_cmd, send_cmd, mds); 5169ae016aeSAlison Schofield 5179ae016aeSAlison Schofield if (rc) 5189ae016aeSAlison Schofield return rc; 5199ae016aeSAlison Schofield 5209ae016aeSAlison Schofield /* Sanitize and construct a cxl_mbox_cmd */ 52159f8d151SDan Williams return cxl_mbox_cmd_ctor(mbox_cmd, mds, mem_cmd.opcode, 5222dd5600aSAlison Schofield mem_cmd.info.size_in, mem_cmd.info.size_out, 5239ae016aeSAlison Schofield send_cmd->in.payload); 5244faf31b4SDan Williams } 5254faf31b4SDan Williams 5264faf31b4SDan Williams int cxl_query_cmd(struct cxl_memdev *cxlmd, 5274faf31b4SDan Williams struct cxl_mem_query_commands __user *q) 5284faf31b4SDan Williams { 52959f8d151SDan Williams struct cxl_memdev_state *mds = to_cxl_memdev_state(cxlmd->cxlds); 5304faf31b4SDan Williams struct device *dev = &cxlmd->dev; 5314faf31b4SDan Williams struct cxl_mem_command *cmd; 5324faf31b4SDan Williams u32 n_commands; 5334faf31b4SDan Williams int j = 0; 5344faf31b4SDan Williams 5354faf31b4SDan Williams dev_dbg(dev, "Query IOCTL\n"); 5364faf31b4SDan Williams 5374faf31b4SDan Williams if (get_user(n_commands, &q->n_commands)) 5384faf31b4SDan Williams return -EFAULT; 5394faf31b4SDan Williams 5404faf31b4SDan Williams /* returns the total number if 0 elements are requested. */ 5414faf31b4SDan Williams if (n_commands == 0) 542ff56ab9eSDan Williams return put_user(ARRAY_SIZE(cxl_mem_commands), &q->n_commands); 5434faf31b4SDan Williams 5444faf31b4SDan Williams /* 5454faf31b4SDan Williams * otherwise, return max(n_commands, total commands) cxl_command_info 5464faf31b4SDan Williams * structures. 5474faf31b4SDan Williams */ 5484faf31b4SDan Williams cxl_for_each_cmd(cmd) { 549814a15f3SIra Weiny struct cxl_command_info info = cmd->info; 5504faf31b4SDan Williams 55159f8d151SDan Williams if (test_bit(info.id, mds->enabled_cmds)) 552814a15f3SIra Weiny info.flags |= CXL_MEM_COMMAND_FLAG_ENABLED; 55359f8d151SDan Williams if (test_bit(info.id, mds->exclusive_cmds)) 554814a15f3SIra Weiny info.flags |= CXL_MEM_COMMAND_FLAG_EXCLUSIVE; 555814a15f3SIra Weiny 556814a15f3SIra Weiny if (copy_to_user(&q->commands[j++], &info, sizeof(info))) 5574faf31b4SDan Williams return -EFAULT; 5584faf31b4SDan Williams 5594faf31b4SDan Williams if (j == n_commands) 5604faf31b4SDan Williams break; 5614faf31b4SDan Williams } 5624faf31b4SDan Williams 5634faf31b4SDan Williams return 0; 5644faf31b4SDan Williams } 5654faf31b4SDan Williams 5664faf31b4SDan Williams /** 5674faf31b4SDan Williams * handle_mailbox_cmd_from_user() - Dispatch a mailbox command for userspace. 56859f8d151SDan Williams * @mds: The driver data for the operation 569d97fe8eeSAlison Schofield * @mbox_cmd: The validated mailbox command. 5704faf31b4SDan Williams * @out_payload: Pointer to userspace's output payload. 5714faf31b4SDan Williams * @size_out: (Input) Max payload size to copy out. 5724faf31b4SDan Williams * (Output) Payload size hardware generated. 5734faf31b4SDan Williams * @retval: Hardware generated return code from the operation. 5744faf31b4SDan Williams * 5754faf31b4SDan Williams * Return: 5764faf31b4SDan Williams * * %0 - Mailbox transaction succeeded. This implies the mailbox 5774faf31b4SDan Williams * protocol completed successfully not that the operation itself 5784faf31b4SDan Williams * was successful. 5794faf31b4SDan Williams * * %-ENOMEM - Couldn't allocate a bounce buffer. 5804faf31b4SDan Williams * * %-EFAULT - Something happened with copy_to/from_user. 5814faf31b4SDan Williams * * %-EINTR - Mailbox acquisition interrupted. 5824faf31b4SDan Williams * * %-EXXX - Transaction level failures. 5834faf31b4SDan Williams * 584d97fe8eeSAlison Schofield * Dispatches a mailbox command on behalf of a userspace request. 585d97fe8eeSAlison Schofield * The output payload is copied to userspace. 5864faf31b4SDan Williams * 5874faf31b4SDan Williams * See cxl_send_cmd(). 5884faf31b4SDan Williams */ 58959f8d151SDan Williams static int handle_mailbox_cmd_from_user(struct cxl_memdev_state *mds, 590d97fe8eeSAlison Schofield struct cxl_mbox_cmd *mbox_cmd, 591d97fe8eeSAlison Schofield u64 out_payload, s32 *size_out, 592d97fe8eeSAlison Schofield u32 *retval) 5934faf31b4SDan Williams { 59459f8d151SDan Williams struct device *dev = mds->cxlds.dev; 5954faf31b4SDan Williams int rc; 5964faf31b4SDan Williams 5974faf31b4SDan Williams dev_dbg(dev, 5984faf31b4SDan Williams "Submitting %s command for user\n" 5994faf31b4SDan Williams "\topcode: %x\n" 60082b8ba29SAlison Schofield "\tsize: %zx\n", 601d97fe8eeSAlison Schofield cxl_mem_opcode_to_name(mbox_cmd->opcode), 602d97fe8eeSAlison Schofield mbox_cmd->opcode, mbox_cmd->size_in); 6034faf31b4SDan Williams 60459f8d151SDan Williams rc = mds->mbox_send(mds, mbox_cmd); 6054faf31b4SDan Williams if (rc) 6064faf31b4SDan Williams goto out; 6074faf31b4SDan Williams 6084faf31b4SDan Williams /* 6094faf31b4SDan Williams * @size_out contains the max size that's allowed to be written back out 6104faf31b4SDan Williams * to userspace. While the payload may have written more output than 6114faf31b4SDan Williams * this it will have to be ignored. 6124faf31b4SDan Williams */ 613d97fe8eeSAlison Schofield if (mbox_cmd->size_out) { 614d97fe8eeSAlison Schofield dev_WARN_ONCE(dev, mbox_cmd->size_out > *size_out, 6154faf31b4SDan Williams "Invalid return size\n"); 6164faf31b4SDan Williams if (copy_to_user(u64_to_user_ptr(out_payload), 617d97fe8eeSAlison Schofield mbox_cmd->payload_out, mbox_cmd->size_out)) { 6184faf31b4SDan Williams rc = -EFAULT; 6194faf31b4SDan Williams goto out; 6204faf31b4SDan Williams } 6214faf31b4SDan Williams } 6224faf31b4SDan Williams 623d97fe8eeSAlison Schofield *size_out = mbox_cmd->size_out; 624d97fe8eeSAlison Schofield *retval = mbox_cmd->return_code; 6254faf31b4SDan Williams 6264faf31b4SDan Williams out: 627d97fe8eeSAlison Schofield cxl_mbox_cmd_dtor(mbox_cmd); 6284faf31b4SDan Williams return rc; 6294faf31b4SDan Williams } 6304faf31b4SDan Williams 6314faf31b4SDan Williams int cxl_send_cmd(struct cxl_memdev *cxlmd, struct cxl_send_command __user *s) 6324faf31b4SDan Williams { 63359f8d151SDan Williams struct cxl_memdev_state *mds = to_cxl_memdev_state(cxlmd->cxlds); 6344faf31b4SDan Williams struct device *dev = &cxlmd->dev; 6354faf31b4SDan Williams struct cxl_send_command send; 6369ae016aeSAlison Schofield struct cxl_mbox_cmd mbox_cmd; 6374faf31b4SDan Williams int rc; 6384faf31b4SDan Williams 6394faf31b4SDan Williams dev_dbg(dev, "Send IOCTL\n"); 6404faf31b4SDan Williams 6414faf31b4SDan Williams if (copy_from_user(&send, s, sizeof(send))) 6424faf31b4SDan Williams return -EFAULT; 6434faf31b4SDan Williams 64459f8d151SDan Williams rc = cxl_validate_cmd_from_user(&mbox_cmd, mds, &send); 6454faf31b4SDan Williams if (rc) 6464faf31b4SDan Williams return rc; 6474faf31b4SDan Williams 64859f8d151SDan Williams rc = handle_mailbox_cmd_from_user(mds, &mbox_cmd, send.out.payload, 649d97fe8eeSAlison Schofield &send.out.size, &send.retval); 6504faf31b4SDan Williams if (rc) 6514faf31b4SDan Williams return rc; 6524faf31b4SDan Williams 6534faf31b4SDan Williams if (copy_to_user(s, &send, sizeof(send))) 6544faf31b4SDan Williams return -EFAULT; 6554faf31b4SDan Williams 6564faf31b4SDan Williams return 0; 6574faf31b4SDan Williams } 6584faf31b4SDan Williams 65959f8d151SDan Williams static int cxl_xfer_log(struct cxl_memdev_state *mds, uuid_t *uuid, 66059f8d151SDan Williams u32 *size, u8 *out) 6614faf31b4SDan Williams { 662623c0751SRobert Richter u32 remaining = *size; 6634faf31b4SDan Williams u32 offset = 0; 6644faf31b4SDan Williams 6654faf31b4SDan Williams while (remaining) { 66659f8d151SDan Williams u32 xfer_size = min_t(u32, remaining, mds->payload_size); 6675331cdf4SDan Williams struct cxl_mbox_cmd mbox_cmd; 6685331cdf4SDan Williams struct cxl_mbox_get_log log; 6694faf31b4SDan Williams int rc; 6704faf31b4SDan Williams 6715331cdf4SDan Williams log = (struct cxl_mbox_get_log) { 6725331cdf4SDan Williams .uuid = *uuid, 6735331cdf4SDan Williams .offset = cpu_to_le32(offset), 6745331cdf4SDan Williams .length = cpu_to_le32(xfer_size), 6755331cdf4SDan Williams }; 6765331cdf4SDan Williams 6775331cdf4SDan Williams mbox_cmd = (struct cxl_mbox_cmd) { 6785331cdf4SDan Williams .opcode = CXL_MBOX_OP_GET_LOG, 6795331cdf4SDan Williams .size_in = sizeof(log), 6805331cdf4SDan Williams .payload_in = &log, 6815331cdf4SDan Williams .size_out = xfer_size, 6825331cdf4SDan Williams .payload_out = out, 6835331cdf4SDan Williams }; 6845331cdf4SDan Williams 68559f8d151SDan Williams rc = cxl_internal_send_cmd(mds, &mbox_cmd); 686623c0751SRobert Richter 687623c0751SRobert Richter /* 688623c0751SRobert Richter * The output payload length that indicates the number 689623c0751SRobert Richter * of valid bytes can be smaller than the Log buffer 690623c0751SRobert Richter * size. 691623c0751SRobert Richter */ 692623c0751SRobert Richter if (rc == -EIO && mbox_cmd.size_out < xfer_size) { 693623c0751SRobert Richter offset += mbox_cmd.size_out; 694623c0751SRobert Richter break; 695623c0751SRobert Richter } 696623c0751SRobert Richter 6974faf31b4SDan Williams if (rc < 0) 6984faf31b4SDan Williams return rc; 6994faf31b4SDan Williams 7004faf31b4SDan Williams out += xfer_size; 7014faf31b4SDan Williams remaining -= xfer_size; 7024faf31b4SDan Williams offset += xfer_size; 7034faf31b4SDan Williams } 7044faf31b4SDan Williams 705623c0751SRobert Richter *size = offset; 706623c0751SRobert Richter 7074faf31b4SDan Williams return 0; 7084faf31b4SDan Williams } 7094faf31b4SDan Williams 7104faf31b4SDan Williams /** 7114faf31b4SDan Williams * cxl_walk_cel() - Walk through the Command Effects Log. 71259f8d151SDan Williams * @mds: The driver data for the operation 7134faf31b4SDan Williams * @size: Length of the Command Effects Log. 7144faf31b4SDan Williams * @cel: CEL 7154faf31b4SDan Williams * 7164faf31b4SDan Williams * Iterate over each entry in the CEL and determine if the driver supports the 7174faf31b4SDan Williams * command. If so, the command is enabled for the device and can be used later. 7184faf31b4SDan Williams */ 71959f8d151SDan Williams static void cxl_walk_cel(struct cxl_memdev_state *mds, size_t size, u8 *cel) 7204faf31b4SDan Williams { 72149be6dd8SDan Williams struct cxl_cel_entry *cel_entry; 7224faf31b4SDan Williams const int cel_entries = size / sizeof(*cel_entry); 72359f8d151SDan Williams struct device *dev = mds->cxlds.dev; 7244faf31b4SDan Williams int i; 7254faf31b4SDan Williams 72649be6dd8SDan Williams cel_entry = (struct cxl_cel_entry *) cel; 7274faf31b4SDan Williams 7284faf31b4SDan Williams for (i = 0; i < cel_entries; i++) { 7294faf31b4SDan Williams u16 opcode = le16_to_cpu(cel_entry[i].opcode); 7304faf31b4SDan Williams struct cxl_mem_command *cmd = cxl_mem_find_command(opcode); 731d2f70605SIra Weiny int enabled = 0; 7324faf31b4SDan Williams 733d2f70605SIra Weiny if (cmd) { 734d2f70605SIra Weiny set_bit(cmd->info.id, mds->enabled_cmds); 735d2f70605SIra Weiny enabled++; 7364faf31b4SDan Williams } 7374faf31b4SDan Williams 738d2f70605SIra Weiny if (cxl_is_poison_command(opcode)) { 73959f8d151SDan Williams cxl_set_poison_cmd_enabled(&mds->poison, opcode); 740d2f70605SIra Weiny enabled++; 741d2f70605SIra Weiny } 742d0abf578SAlison Schofield 743d2f70605SIra Weiny if (cxl_is_security_command(opcode)) { 744ad64f595SDavidlohr Bueso cxl_set_security_cmd_enabled(&mds->security, opcode); 745d2f70605SIra Weiny enabled++; 746d2f70605SIra Weiny } 747ad64f595SDavidlohr Bueso 748d2f70605SIra Weiny dev_dbg(dev, "Opcode 0x%04x %s\n", opcode, 749d2f70605SIra Weiny enabled ? "enabled" : "unsupported by driver"); 7504faf31b4SDan Williams } 7514faf31b4SDan Williams } 7524faf31b4SDan Williams 75359f8d151SDan Williams static struct cxl_mbox_get_supported_logs *cxl_get_gsl(struct cxl_memdev_state *mds) 7544faf31b4SDan Williams { 7554faf31b4SDan Williams struct cxl_mbox_get_supported_logs *ret; 7565331cdf4SDan Williams struct cxl_mbox_cmd mbox_cmd; 7574faf31b4SDan Williams int rc; 7584faf31b4SDan Williams 75959f8d151SDan Williams ret = kvmalloc(mds->payload_size, GFP_KERNEL); 7604faf31b4SDan Williams if (!ret) 7614faf31b4SDan Williams return ERR_PTR(-ENOMEM); 7624faf31b4SDan Williams 7635331cdf4SDan Williams mbox_cmd = (struct cxl_mbox_cmd) { 7645331cdf4SDan Williams .opcode = CXL_MBOX_OP_GET_SUPPORTED_LOGS, 76559f8d151SDan Williams .size_out = mds->payload_size, 7665331cdf4SDan Williams .payload_out = ret, 7672aeaf663SDan Williams /* At least the record number field must be valid */ 7682aeaf663SDan Williams .min_out = 2, 7695331cdf4SDan Williams }; 77059f8d151SDan Williams rc = cxl_internal_send_cmd(mds, &mbox_cmd); 7714faf31b4SDan Williams if (rc < 0) { 7724faf31b4SDan Williams kvfree(ret); 7734faf31b4SDan Williams return ERR_PTR(rc); 7744faf31b4SDan Williams } 7754faf31b4SDan Williams 7765331cdf4SDan Williams 7774faf31b4SDan Williams return ret; 7784faf31b4SDan Williams } 7794faf31b4SDan Williams 7804faf31b4SDan Williams enum { 7814faf31b4SDan Williams CEL_UUID, 7824faf31b4SDan Williams VENDOR_DEBUG_UUID, 7834faf31b4SDan Williams }; 7844faf31b4SDan Williams 7854faf31b4SDan Williams /* See CXL 2.0 Table 170. Get Log Input Payload */ 7864faf31b4SDan Williams static const uuid_t log_uuid[] = { 78749be6dd8SDan Williams [CEL_UUID] = DEFINE_CXL_CEL_UUID, 78849be6dd8SDan Williams [VENDOR_DEBUG_UUID] = DEFINE_CXL_VENDOR_DEBUG_UUID, 7894faf31b4SDan Williams }; 7904faf31b4SDan Williams 7914faf31b4SDan Williams /** 7925e2411aeSIra Weiny * cxl_enumerate_cmds() - Enumerate commands for a device. 79359f8d151SDan Williams * @mds: The driver data for the operation 7944faf31b4SDan Williams * 7954faf31b4SDan Williams * Returns 0 if enumerate completed successfully. 7964faf31b4SDan Williams * 7974faf31b4SDan Williams * CXL devices have optional support for certain commands. This function will 7984faf31b4SDan Williams * determine the set of supported commands for the hardware and update the 79959f8d151SDan Williams * enabled_cmds bitmap in the @mds. 8004faf31b4SDan Williams */ 80159f8d151SDan Williams int cxl_enumerate_cmds(struct cxl_memdev_state *mds) 8024faf31b4SDan Williams { 8034faf31b4SDan Williams struct cxl_mbox_get_supported_logs *gsl; 80459f8d151SDan Williams struct device *dev = mds->cxlds.dev; 8054faf31b4SDan Williams struct cxl_mem_command *cmd; 8064faf31b4SDan Williams int i, rc; 8074faf31b4SDan Williams 80859f8d151SDan Williams gsl = cxl_get_gsl(mds); 8094faf31b4SDan Williams if (IS_ERR(gsl)) 8104faf31b4SDan Williams return PTR_ERR(gsl); 8114faf31b4SDan Williams 8124faf31b4SDan Williams rc = -ENOENT; 8134faf31b4SDan Williams for (i = 0; i < le16_to_cpu(gsl->entries); i++) { 8144faf31b4SDan Williams u32 size = le32_to_cpu(gsl->entry[i].size); 8154faf31b4SDan Williams uuid_t uuid = gsl->entry[i].uuid; 8164faf31b4SDan Williams u8 *log; 8174faf31b4SDan Williams 8184faf31b4SDan Williams dev_dbg(dev, "Found LOG type %pU of size %d", &uuid, size); 8194faf31b4SDan Williams 8204faf31b4SDan Williams if (!uuid_equal(&uuid, &log_uuid[CEL_UUID])) 8214faf31b4SDan Williams continue; 8224faf31b4SDan Williams 8234faf31b4SDan Williams log = kvmalloc(size, GFP_KERNEL); 8244faf31b4SDan Williams if (!log) { 8254faf31b4SDan Williams rc = -ENOMEM; 8264faf31b4SDan Williams goto out; 8274faf31b4SDan Williams } 8284faf31b4SDan Williams 82959f8d151SDan Williams rc = cxl_xfer_log(mds, &uuid, &size, log); 8304faf31b4SDan Williams if (rc) { 8314faf31b4SDan Williams kvfree(log); 8324faf31b4SDan Williams goto out; 8334faf31b4SDan Williams } 8344faf31b4SDan Williams 83559f8d151SDan Williams cxl_walk_cel(mds, size, log); 8364faf31b4SDan Williams kvfree(log); 8374faf31b4SDan Williams 8384faf31b4SDan Williams /* In case CEL was bogus, enable some default commands. */ 8394faf31b4SDan Williams cxl_for_each_cmd(cmd) 8404faf31b4SDan Williams if (cmd->flags & CXL_CMD_FLAG_FORCE_ENABLE) 84159f8d151SDan Williams set_bit(cmd->info.id, mds->enabled_cmds); 8424faf31b4SDan Williams 8434faf31b4SDan Williams /* Found the required CEL */ 8444faf31b4SDan Williams rc = 0; 8454faf31b4SDan Williams } 8464faf31b4SDan Williams out: 8474faf31b4SDan Williams kvfree(gsl); 8484faf31b4SDan Williams return rc; 8494faf31b4SDan Williams } 850affec782SDan Williams EXPORT_SYMBOL_NS_GPL(cxl_enumerate_cmds, CXL); 8514faf31b4SDan Williams 852dc97f634SIra Weiny void cxl_event_trace_record(const struct cxl_memdev *cxlmd, 853dc97f634SIra Weiny enum cxl_event_log_type type, 854dc97f634SIra Weiny enum cxl_event_type event_type, 855dc97f634SIra Weiny const uuid_t *uuid, union cxl_event *evt) 856dc97f634SIra Weiny { 857dc97f634SIra Weiny if (event_type == CXL_CPER_EVENT_GEN_MEDIA) 858dc97f634SIra Weiny trace_cxl_general_media(cxlmd, type, &evt->gen_media); 859dc97f634SIra Weiny else if (event_type == CXL_CPER_EVENT_DRAM) 860dc97f634SIra Weiny trace_cxl_dram(cxlmd, type, &evt->dram); 861dc97f634SIra Weiny else if (event_type == CXL_CPER_EVENT_MEM_MODULE) 862dc97f634SIra Weiny trace_cxl_memory_module(cxlmd, type, &evt->mem_module); 863dc97f634SIra Weiny else 864dc97f634SIra Weiny trace_cxl_generic_event(cxlmd, type, uuid, &evt->generic); 865dc97f634SIra Weiny } 866dc97f634SIra Weiny EXPORT_SYMBOL_NS_GPL(cxl_event_trace_record, CXL); 867d54a531aSIra Weiny 868dc97f634SIra Weiny static void __cxl_event_trace_record(const struct cxl_memdev *cxlmd, 869d54a531aSIra Weiny enum cxl_event_log_type type, 870d54a531aSIra Weiny struct cxl_event_record_raw *record) 871d54a531aSIra Weiny { 872dc97f634SIra Weiny enum cxl_event_type ev_type = CXL_CPER_EVENT_GENERIC; 873dc97f634SIra Weiny const uuid_t *uuid = &record->id; 874d54a531aSIra Weiny 875dc97f634SIra Weiny if (uuid_equal(uuid, &CXL_EVENT_GEN_MEDIA_UUID)) 876dc97f634SIra Weiny ev_type = CXL_CPER_EVENT_GEN_MEDIA; 877dc97f634SIra Weiny else if (uuid_equal(uuid, &CXL_EVENT_DRAM_UUID)) 878dc97f634SIra Weiny ev_type = CXL_CPER_EVENT_DRAM; 879dc97f634SIra Weiny else if (uuid_equal(uuid, &CXL_EVENT_MEM_MODULE_UUID)) 880dc97f634SIra Weiny ev_type = CXL_CPER_EVENT_MEM_MODULE; 881d54a531aSIra Weiny 882dc97f634SIra Weiny cxl_event_trace_record(cxlmd, type, ev_type, uuid, &record->event); 883d54a531aSIra Weiny } 884d54a531aSIra Weiny 88559f8d151SDan Williams static int cxl_clear_event_record(struct cxl_memdev_state *mds, 8866ebe28f9SIra Weiny enum cxl_event_log_type log, 8876ebe28f9SIra Weiny struct cxl_get_event_payload *get_pl) 8886ebe28f9SIra Weiny { 8896ebe28f9SIra Weiny struct cxl_mbox_clear_event_payload *payload; 8906ebe28f9SIra Weiny u16 total = le16_to_cpu(get_pl->record_count); 8916ebe28f9SIra Weiny u8 max_handles = CXL_CLEAR_EVENT_MAX_HANDLES; 8926ebe28f9SIra Weiny size_t pl_size = struct_size(payload, handles, max_handles); 8936ebe28f9SIra Weiny struct cxl_mbox_cmd mbox_cmd; 8946ebe28f9SIra Weiny u16 cnt; 8956ebe28f9SIra Weiny int rc = 0; 8966ebe28f9SIra Weiny int i; 8976ebe28f9SIra Weiny 8986ebe28f9SIra Weiny /* Payload size may limit the max handles */ 89959f8d151SDan Williams if (pl_size > mds->payload_size) { 90059f8d151SDan Williams max_handles = (mds->payload_size - sizeof(*payload)) / 9016ebe28f9SIra Weiny sizeof(__le16); 9026ebe28f9SIra Weiny pl_size = struct_size(payload, handles, max_handles); 9036ebe28f9SIra Weiny } 9046ebe28f9SIra Weiny 9056ebe28f9SIra Weiny payload = kvzalloc(pl_size, GFP_KERNEL); 9066ebe28f9SIra Weiny if (!payload) 9076ebe28f9SIra Weiny return -ENOMEM; 9086ebe28f9SIra Weiny 9096ebe28f9SIra Weiny *payload = (struct cxl_mbox_clear_event_payload) { 9106ebe28f9SIra Weiny .event_log = log, 9116ebe28f9SIra Weiny }; 9126ebe28f9SIra Weiny 9136ebe28f9SIra Weiny mbox_cmd = (struct cxl_mbox_cmd) { 9146ebe28f9SIra Weiny .opcode = CXL_MBOX_OP_CLEAR_EVENT_RECORD, 9156ebe28f9SIra Weiny .payload_in = payload, 9166ebe28f9SIra Weiny .size_in = pl_size, 9176ebe28f9SIra Weiny }; 9186ebe28f9SIra Weiny 9196ebe28f9SIra Weiny /* 9206ebe28f9SIra Weiny * Clear Event Records uses u8 for the handle cnt while Get Event 9216ebe28f9SIra Weiny * Record can return up to 0xffff records. 9226ebe28f9SIra Weiny */ 9236ebe28f9SIra Weiny i = 0; 9246ebe28f9SIra Weiny for (cnt = 0; cnt < total; cnt++) { 925f9c68338SIra Weiny struct cxl_event_record_raw *raw = &get_pl->records[cnt]; 926f9c68338SIra Weiny struct cxl_event_generic *gen = &raw->event.generic; 927f9c68338SIra Weiny 928f9c68338SIra Weiny payload->handles[i++] = gen->hdr.handle; 92959f8d151SDan Williams dev_dbg(mds->cxlds.dev, "Event log '%d': Clearing %u\n", log, 930b7c59b03SYuquan Wang le16_to_cpu(payload->handles[i - 1])); 9316ebe28f9SIra Weiny 9326ebe28f9SIra Weiny if (i == max_handles) { 9336ebe28f9SIra Weiny payload->nr_recs = i; 93459f8d151SDan Williams rc = cxl_internal_send_cmd(mds, &mbox_cmd); 9356ebe28f9SIra Weiny if (rc) 9366ebe28f9SIra Weiny goto free_pl; 9376ebe28f9SIra Weiny i = 0; 9386ebe28f9SIra Weiny } 9396ebe28f9SIra Weiny } 9406ebe28f9SIra Weiny 9416ebe28f9SIra Weiny /* Clear what is left if any */ 9426ebe28f9SIra Weiny if (i) { 9436ebe28f9SIra Weiny payload->nr_recs = i; 9446ebe28f9SIra Weiny mbox_cmd.size_in = struct_size(payload, handles, i); 94559f8d151SDan Williams rc = cxl_internal_send_cmd(mds, &mbox_cmd); 9466ebe28f9SIra Weiny if (rc) 9476ebe28f9SIra Weiny goto free_pl; 9486ebe28f9SIra Weiny } 9496ebe28f9SIra Weiny 9506ebe28f9SIra Weiny free_pl: 9516ebe28f9SIra Weiny kvfree(payload); 9526ebe28f9SIra Weiny return rc; 9536ebe28f9SIra Weiny } 9546ebe28f9SIra Weiny 95559f8d151SDan Williams static void cxl_mem_get_records_log(struct cxl_memdev_state *mds, 9566ebe28f9SIra Weiny enum cxl_event_log_type type) 9576ebe28f9SIra Weiny { 95859f8d151SDan Williams struct cxl_memdev *cxlmd = mds->cxlds.cxlmd; 95959f8d151SDan Williams struct device *dev = mds->cxlds.dev; 9606ebe28f9SIra Weiny struct cxl_get_event_payload *payload; 9616ebe28f9SIra Weiny u8 log_type = type; 9626ebe28f9SIra Weiny u16 nr_rec; 9636ebe28f9SIra Weiny 96459f8d151SDan Williams mutex_lock(&mds->event.log_lock); 96559f8d151SDan Williams payload = mds->event.buf; 9666ebe28f9SIra Weiny 9674b759dd5SDan Williams do { 9684b759dd5SDan Williams int rc, i; 9694b759dd5SDan Williams struct cxl_mbox_cmd mbox_cmd = (struct cxl_mbox_cmd) { 9706ebe28f9SIra Weiny .opcode = CXL_MBOX_OP_GET_EVENT_RECORD, 9716ebe28f9SIra Weiny .payload_in = &log_type, 9726ebe28f9SIra Weiny .size_in = sizeof(log_type), 9736ebe28f9SIra Weiny .payload_out = payload, 9744b759dd5SDan Williams .size_out = mds->payload_size, 9756ebe28f9SIra Weiny .min_out = struct_size(payload, records, 0), 9766ebe28f9SIra Weiny }; 9776ebe28f9SIra Weiny 97859f8d151SDan Williams rc = cxl_internal_send_cmd(mds, &mbox_cmd); 9796ebe28f9SIra Weiny if (rc) { 98059f8d151SDan Williams dev_err_ratelimited(dev, 9816ebe28f9SIra Weiny "Event log '%d': Failed to query event records : %d", 9826ebe28f9SIra Weiny type, rc); 9836ebe28f9SIra Weiny break; 9846ebe28f9SIra Weiny } 9856ebe28f9SIra Weiny 9866ebe28f9SIra Weiny nr_rec = le16_to_cpu(payload->record_count); 9876ebe28f9SIra Weiny if (!nr_rec) 9886ebe28f9SIra Weiny break; 9896ebe28f9SIra Weiny 9906ebe28f9SIra Weiny for (i = 0; i < nr_rec; i++) 991dc97f634SIra Weiny __cxl_event_trace_record(cxlmd, type, 9926ebe28f9SIra Weiny &payload->records[i]); 9936ebe28f9SIra Weiny 9946ebe28f9SIra Weiny if (payload->flags & CXL_GET_EVENT_FLAG_OVERFLOW) 99559f8d151SDan Williams trace_cxl_overflow(cxlmd, type, payload); 9966ebe28f9SIra Weiny 99759f8d151SDan Williams rc = cxl_clear_event_record(mds, type, payload); 9986ebe28f9SIra Weiny if (rc) { 99959f8d151SDan Williams dev_err_ratelimited(dev, 10006ebe28f9SIra Weiny "Event log '%d': Failed to clear events : %d", 10016ebe28f9SIra Weiny type, rc); 10026ebe28f9SIra Weiny break; 10036ebe28f9SIra Weiny } 10046ebe28f9SIra Weiny } while (nr_rec); 10056ebe28f9SIra Weiny 100659f8d151SDan Williams mutex_unlock(&mds->event.log_lock); 10076ebe28f9SIra Weiny } 10086ebe28f9SIra Weiny 10096ebe28f9SIra Weiny /** 10106ebe28f9SIra Weiny * cxl_mem_get_event_records - Get Event Records from the device 101159f8d151SDan Williams * @mds: The driver data for the operation 10127ebf38c9SJonathan Cameron * @status: Event Status register value identifying which events are available. 10136ebe28f9SIra Weiny * 10146ebe28f9SIra Weiny * Retrieve all event records available on the device, report them as trace 10156ebe28f9SIra Weiny * events, and clear them. 10166ebe28f9SIra Weiny * 10176ebe28f9SIra Weiny * See CXL rev 3.0 @8.2.9.2.2 Get Event Records 10186ebe28f9SIra Weiny * See CXL rev 3.0 @8.2.9.2.3 Clear Event Records 10196ebe28f9SIra Weiny */ 102059f8d151SDan Williams void cxl_mem_get_event_records(struct cxl_memdev_state *mds, u32 status) 10216ebe28f9SIra Weiny { 102259f8d151SDan Williams dev_dbg(mds->cxlds.dev, "Reading event logs: %x\n", status); 10236ebe28f9SIra Weiny 10246ebe28f9SIra Weiny if (status & CXLDEV_EVENT_STATUS_FATAL) 102559f8d151SDan Williams cxl_mem_get_records_log(mds, CXL_EVENT_TYPE_FATAL); 10266ebe28f9SIra Weiny if (status & CXLDEV_EVENT_STATUS_FAIL) 102759f8d151SDan Williams cxl_mem_get_records_log(mds, CXL_EVENT_TYPE_FAIL); 10286ebe28f9SIra Weiny if (status & CXLDEV_EVENT_STATUS_WARN) 102959f8d151SDan Williams cxl_mem_get_records_log(mds, CXL_EVENT_TYPE_WARN); 10306ebe28f9SIra Weiny if (status & CXLDEV_EVENT_STATUS_INFO) 103159f8d151SDan Williams cxl_mem_get_records_log(mds, CXL_EVENT_TYPE_INFO); 10326ebe28f9SIra Weiny } 10336ebe28f9SIra Weiny EXPORT_SYMBOL_NS_GPL(cxl_mem_get_event_records, CXL); 10346ebe28f9SIra Weiny 10354faf31b4SDan Williams /** 10364faf31b4SDan Williams * cxl_mem_get_partition_info - Get partition info 103759f8d151SDan Williams * @mds: The driver data for the operation 10384faf31b4SDan Williams * 10394faf31b4SDan Williams * Retrieve the current partition info for the device specified. The active 10404faf31b4SDan Williams * values are the current capacity in bytes. If not 0, the 'next' values are 10414faf31b4SDan Williams * the pending values, in bytes, which take affect on next cold reset. 10424faf31b4SDan Williams * 10434faf31b4SDan Williams * Return: 0 if no error: or the result of the mailbox command. 10444faf31b4SDan Williams * 10454faf31b4SDan Williams * See CXL @8.2.9.5.2.1 Get Partition Info 10464faf31b4SDan Williams */ 104759f8d151SDan Williams static int cxl_mem_get_partition_info(struct cxl_memdev_state *mds) 10484faf31b4SDan Williams { 1049e7ad1bf6SDan Williams struct cxl_mbox_get_partition_info pi; 10505331cdf4SDan Williams struct cxl_mbox_cmd mbox_cmd; 10514faf31b4SDan Williams int rc; 10524faf31b4SDan Williams 10535331cdf4SDan Williams mbox_cmd = (struct cxl_mbox_cmd) { 10545331cdf4SDan Williams .opcode = CXL_MBOX_OP_GET_PARTITION_INFO, 10555331cdf4SDan Williams .size_out = sizeof(pi), 10565331cdf4SDan Williams .payload_out = &pi, 10575331cdf4SDan Williams }; 105859f8d151SDan Williams rc = cxl_internal_send_cmd(mds, &mbox_cmd); 10594faf31b4SDan Williams if (rc) 10604faf31b4SDan Williams return rc; 10614faf31b4SDan Williams 106259f8d151SDan Williams mds->active_volatile_bytes = 10634faf31b4SDan Williams le64_to_cpu(pi.active_volatile_cap) * CXL_CAPACITY_MULTIPLIER; 106459f8d151SDan Williams mds->active_persistent_bytes = 10654faf31b4SDan Williams le64_to_cpu(pi.active_persistent_cap) * CXL_CAPACITY_MULTIPLIER; 106659f8d151SDan Williams mds->next_volatile_bytes = 10674faf31b4SDan Williams le64_to_cpu(pi.next_volatile_cap) * CXL_CAPACITY_MULTIPLIER; 106859f8d151SDan Williams mds->next_persistent_bytes = 10694faf31b4SDan Williams le64_to_cpu(pi.next_volatile_cap) * CXL_CAPACITY_MULTIPLIER; 10704faf31b4SDan Williams 10714faf31b4SDan Williams return 0; 10724faf31b4SDan Williams } 10734faf31b4SDan Williams 10744faf31b4SDan Williams /** 10755e2411aeSIra Weiny * cxl_dev_state_identify() - Send the IDENTIFY command to the device. 107659f8d151SDan Williams * @mds: The driver data for the operation 10774faf31b4SDan Williams * 1078e764f122SDave Jiang * Return: 0 if identify was executed successfully or media not ready. 10794faf31b4SDan Williams * 10804faf31b4SDan Williams * This will dispatch the identify command to the device and on success populate 10814faf31b4SDan Williams * structures to be exported to sysfs. 10824faf31b4SDan Williams */ 108359f8d151SDan Williams int cxl_dev_state_identify(struct cxl_memdev_state *mds) 10844faf31b4SDan Williams { 10854faf31b4SDan Williams /* See CXL 2.0 Table 175 Identify Memory Device Output Payload */ 108649be6dd8SDan Williams struct cxl_mbox_identify id; 10875331cdf4SDan Williams struct cxl_mbox_cmd mbox_cmd; 1088ed83f7caSAlison Schofield u32 val; 10894faf31b4SDan Williams int rc; 10904faf31b4SDan Williams 109159f8d151SDan Williams if (!mds->cxlds.media_ready) 1092e764f122SDave Jiang return 0; 1093e764f122SDave Jiang 10945331cdf4SDan Williams mbox_cmd = (struct cxl_mbox_cmd) { 10955331cdf4SDan Williams .opcode = CXL_MBOX_OP_IDENTIFY, 10965331cdf4SDan Williams .size_out = sizeof(id), 10975331cdf4SDan Williams .payload_out = &id, 10985331cdf4SDan Williams }; 109959f8d151SDan Williams rc = cxl_internal_send_cmd(mds, &mbox_cmd); 11004faf31b4SDan Williams if (rc < 0) 11014faf31b4SDan Williams return rc; 11024faf31b4SDan Williams 110359f8d151SDan Williams mds->total_bytes = 11044faf31b4SDan Williams le64_to_cpu(id.total_capacity) * CXL_CAPACITY_MULTIPLIER; 110559f8d151SDan Williams mds->volatile_only_bytes = 11064faf31b4SDan Williams le64_to_cpu(id.volatile_capacity) * CXL_CAPACITY_MULTIPLIER; 110759f8d151SDan Williams mds->persistent_only_bytes = 11084faf31b4SDan Williams le64_to_cpu(id.persistent_capacity) * CXL_CAPACITY_MULTIPLIER; 110959f8d151SDan Williams mds->partition_align_bytes = 11104faf31b4SDan Williams le64_to_cpu(id.partition_align) * CXL_CAPACITY_MULTIPLIER; 11114faf31b4SDan Williams 111259f8d151SDan Williams mds->lsa_size = le32_to_cpu(id.lsa_size); 111359f8d151SDan Williams memcpy(mds->firmware_version, id.fw_revision, 111459f8d151SDan Williams sizeof(id.fw_revision)); 11154faf31b4SDan Williams 111659f8d151SDan Williams if (test_bit(CXL_POISON_ENABLED_LIST, mds->poison.enabled_cmds)) { 1117ed83f7caSAlison Schofield val = get_unaligned_le24(id.poison_list_max_mer); 111859f8d151SDan Williams mds->poison.max_errors = min_t(u32, val, CXL_POISON_LIST_MAX); 1119ed83f7caSAlison Schofield } 1120ed83f7caSAlison Schofield 11214faf31b4SDan Williams return 0; 11224faf31b4SDan Williams } 1123affec782SDan Williams EXPORT_SYMBOL_NS_GPL(cxl_dev_state_identify, CXL); 11244faf31b4SDan Williams 112533981838SDan Williams static int __cxl_mem_sanitize(struct cxl_memdev_state *mds, u16 cmd) 112648dcdbb1SDavidlohr Bueso { 112748dcdbb1SDavidlohr Bueso int rc; 112848dcdbb1SDavidlohr Bueso u32 sec_out = 0; 112948dcdbb1SDavidlohr Bueso struct cxl_get_security_output { 113048dcdbb1SDavidlohr Bueso __le32 flags; 113148dcdbb1SDavidlohr Bueso } out; 113248dcdbb1SDavidlohr Bueso struct cxl_mbox_cmd sec_cmd = { 113348dcdbb1SDavidlohr Bueso .opcode = CXL_MBOX_OP_GET_SECURITY_STATE, 113448dcdbb1SDavidlohr Bueso .payload_out = &out, 113548dcdbb1SDavidlohr Bueso .size_out = sizeof(out), 113648dcdbb1SDavidlohr Bueso }; 113748dcdbb1SDavidlohr Bueso struct cxl_mbox_cmd mbox_cmd = { .opcode = cmd }; 1138aeaefabcSDan Williams struct cxl_dev_state *cxlds = &mds->cxlds; 113948dcdbb1SDavidlohr Bueso 1140180ffd33SDavidlohr Bueso if (cmd != CXL_MBOX_OP_SANITIZE && cmd != CXL_MBOX_OP_SECURE_ERASE) 114148dcdbb1SDavidlohr Bueso return -EINVAL; 114248dcdbb1SDavidlohr Bueso 1143aeaefabcSDan Williams rc = cxl_internal_send_cmd(mds, &sec_cmd); 114448dcdbb1SDavidlohr Bueso if (rc < 0) { 114548dcdbb1SDavidlohr Bueso dev_err(cxlds->dev, "Failed to get security state : %d", rc); 114648dcdbb1SDavidlohr Bueso return rc; 114748dcdbb1SDavidlohr Bueso } 114848dcdbb1SDavidlohr Bueso 114948dcdbb1SDavidlohr Bueso /* 115048dcdbb1SDavidlohr Bueso * Prior to using these commands, any security applied to 115148dcdbb1SDavidlohr Bueso * the user data areas of the device shall be DISABLED (or 115248dcdbb1SDavidlohr Bueso * UNLOCKED for secure erase case). 115348dcdbb1SDavidlohr Bueso */ 115448dcdbb1SDavidlohr Bueso sec_out = le32_to_cpu(out.flags); 115548dcdbb1SDavidlohr Bueso if (sec_out & CXL_PMEM_SEC_STATE_USER_PASS_SET) 115648dcdbb1SDavidlohr Bueso return -EINVAL; 115748dcdbb1SDavidlohr Bueso 1158180ffd33SDavidlohr Bueso if (cmd == CXL_MBOX_OP_SECURE_ERASE && 1159180ffd33SDavidlohr Bueso sec_out & CXL_PMEM_SEC_STATE_LOCKED) 1160180ffd33SDavidlohr Bueso return -EINVAL; 1161180ffd33SDavidlohr Bueso 1162aeaefabcSDan Williams rc = cxl_internal_send_cmd(mds, &mbox_cmd); 116348dcdbb1SDavidlohr Bueso if (rc < 0) { 116448dcdbb1SDavidlohr Bueso dev_err(cxlds->dev, "Failed to sanitize device : %d", rc); 116548dcdbb1SDavidlohr Bueso return rc; 116648dcdbb1SDavidlohr Bueso } 116748dcdbb1SDavidlohr Bueso 116848dcdbb1SDavidlohr Bueso return 0; 116948dcdbb1SDavidlohr Bueso } 117033981838SDan Williams 117133981838SDan Williams 117233981838SDan Williams /** 117333981838SDan Williams * cxl_mem_sanitize() - Send a sanitization command to the device. 117433981838SDan Williams * @cxlmd: The device for the operation 117533981838SDan Williams * @cmd: The specific sanitization command opcode 117633981838SDan Williams * 117733981838SDan Williams * Return: 0 if the command was executed successfully, regardless of 117833981838SDan Williams * whether or not the actual security operation is done in the background, 117933981838SDan Williams * such as for the Sanitize case. 118033981838SDan Williams * Error return values can be the result of the mailbox command, -EINVAL 118133981838SDan Williams * when security requirements are not met or invalid contexts, or -EBUSY 118233981838SDan Williams * if the sanitize operation is already in flight. 118333981838SDan Williams * 118433981838SDan Williams * See CXL 3.0 @8.2.9.8.5.1 Sanitize and @8.2.9.8.5.2 Secure Erase. 118533981838SDan Williams */ 118633981838SDan Williams int cxl_mem_sanitize(struct cxl_memdev *cxlmd, u16 cmd) 118733981838SDan Williams { 118833981838SDan Williams struct cxl_memdev_state *mds = to_cxl_memdev_state(cxlmd->cxlds); 118933981838SDan Williams struct cxl_port *endpoint; 119033981838SDan Williams int rc; 119133981838SDan Williams 119233981838SDan Williams /* synchronize with cxl_mem_probe() and decoder write operations */ 119333981838SDan Williams device_lock(&cxlmd->dev); 119433981838SDan Williams endpoint = cxlmd->endpoint; 119533981838SDan Williams down_read(&cxl_region_rwsem); 119633981838SDan Williams /* 119733981838SDan Williams * Require an endpoint to be safe otherwise the driver can not 119833981838SDan Williams * be sure that the device is unmapped. 119933981838SDan Williams */ 1200458ba818SDave Jiang if (endpoint && cxl_num_decoders_committed(endpoint) == 0) 120133981838SDan Williams rc = __cxl_mem_sanitize(mds, cmd); 120233981838SDan Williams else 120333981838SDan Williams rc = -EBUSY; 120433981838SDan Williams up_read(&cxl_region_rwsem); 120533981838SDan Williams device_unlock(&cxlmd->dev); 120633981838SDan Williams 120733981838SDan Williams return rc; 120833981838SDan Williams } 120948dcdbb1SDavidlohr Bueso 1210d3b75029SDan Williams static int add_dpa_res(struct device *dev, struct resource *parent, 1211d3b75029SDan Williams struct resource *res, resource_size_t start, 1212d3b75029SDan Williams resource_size_t size, const char *type) 12134faf31b4SDan Williams { 12144faf31b4SDan Williams int rc; 12154faf31b4SDan Williams 1216d3b75029SDan Williams res->name = type; 1217d3b75029SDan Williams res->start = start; 1218d3b75029SDan Williams res->end = start + size - 1; 1219d3b75029SDan Williams res->flags = IORESOURCE_MEM; 1220d3b75029SDan Williams if (resource_size(res) == 0) { 1221d3b75029SDan Williams dev_dbg(dev, "DPA(%s): no capacity\n", res->name); 12224faf31b4SDan Williams return 0; 12234faf31b4SDan Williams } 1224d3b75029SDan Williams rc = request_resource(parent, res); 1225d3b75029SDan Williams if (rc) { 1226d3b75029SDan Williams dev_err(dev, "DPA(%s): failed to track %pr (%d)\n", res->name, 1227d3b75029SDan Williams res, rc); 1228d3b75029SDan Williams return rc; 1229d3b75029SDan Williams } 1230d3b75029SDan Williams 1231d3b75029SDan Williams dev_dbg(dev, "DPA(%s): %pr\n", res->name, res); 1232d3b75029SDan Williams 1233d3b75029SDan Williams return 0; 1234d3b75029SDan Williams } 1235d3b75029SDan Williams 123659f8d151SDan Williams int cxl_mem_create_range_info(struct cxl_memdev_state *mds) 1237d3b75029SDan Williams { 123859f8d151SDan Williams struct cxl_dev_state *cxlds = &mds->cxlds; 1239d3b75029SDan Williams struct device *dev = cxlds->dev; 1240d3b75029SDan Williams int rc; 1241d3b75029SDan Williams 1242793a539aSDave Jiang if (!cxlds->media_ready) { 1243793a539aSDave Jiang cxlds->dpa_res = DEFINE_RES_MEM(0, 0); 1244793a539aSDave Jiang cxlds->ram_res = DEFINE_RES_MEM(0, 0); 1245793a539aSDave Jiang cxlds->pmem_res = DEFINE_RES_MEM(0, 0); 1246793a539aSDave Jiang return 0; 1247793a539aSDave Jiang } 1248793a539aSDave Jiang 12499214c9d5SAlison Schofield cxlds->dpa_res = DEFINE_RES_MEM(0, mds->total_bytes); 1250d3b75029SDan Williams 125159f8d151SDan Williams if (mds->partition_align_bytes == 0) { 1252d3b75029SDan Williams rc = add_dpa_res(dev, &cxlds->dpa_res, &cxlds->ram_res, 0, 125359f8d151SDan Williams mds->volatile_only_bytes, "ram"); 1254d3b75029SDan Williams if (rc) 1255d3b75029SDan Williams return rc; 1256d3b75029SDan Williams return add_dpa_res(dev, &cxlds->dpa_res, &cxlds->pmem_res, 125759f8d151SDan Williams mds->volatile_only_bytes, 125859f8d151SDan Williams mds->persistent_only_bytes, "pmem"); 1259d3b75029SDan Williams } 12604faf31b4SDan Williams 126159f8d151SDan Williams rc = cxl_mem_get_partition_info(mds); 12624faf31b4SDan Williams if (rc) { 1263d3b75029SDan Williams dev_err(dev, "Failed to query partition information\n"); 12644faf31b4SDan Williams return rc; 12654faf31b4SDan Williams } 12664faf31b4SDan Williams 1267d3b75029SDan Williams rc = add_dpa_res(dev, &cxlds->dpa_res, &cxlds->ram_res, 0, 126859f8d151SDan Williams mds->active_volatile_bytes, "ram"); 1269d3b75029SDan Williams if (rc) 1270d3b75029SDan Williams return rc; 1271d3b75029SDan Williams return add_dpa_res(dev, &cxlds->dpa_res, &cxlds->pmem_res, 127259f8d151SDan Williams mds->active_volatile_bytes, 127359f8d151SDan Williams mds->active_persistent_bytes, "pmem"); 12744faf31b4SDan Williams } 1275affec782SDan Williams EXPORT_SYMBOL_NS_GPL(cxl_mem_create_range_info, CXL); 12764faf31b4SDan Williams 127759f8d151SDan Williams int cxl_set_timestamp(struct cxl_memdev_state *mds) 1278fa884345SJonathan Cameron { 1279fa884345SJonathan Cameron struct cxl_mbox_cmd mbox_cmd; 1280fa884345SJonathan Cameron struct cxl_mbox_set_timestamp_in pi; 1281fa884345SJonathan Cameron int rc; 1282fa884345SJonathan Cameron 1283fa884345SJonathan Cameron pi.timestamp = cpu_to_le64(ktime_get_real_ns()); 1284fa884345SJonathan Cameron mbox_cmd = (struct cxl_mbox_cmd) { 1285fa884345SJonathan Cameron .opcode = CXL_MBOX_OP_SET_TIMESTAMP, 1286fa884345SJonathan Cameron .size_in = sizeof(pi), 1287fa884345SJonathan Cameron .payload_in = &pi, 1288fa884345SJonathan Cameron }; 1289fa884345SJonathan Cameron 129059f8d151SDan Williams rc = cxl_internal_send_cmd(mds, &mbox_cmd); 1291fa884345SJonathan Cameron /* 1292fa884345SJonathan Cameron * Command is optional. Devices may have another way of providing 1293fa884345SJonathan Cameron * a timestamp, or may return all 0s in timestamp fields. 1294fa884345SJonathan Cameron * Don't report an error if this command isn't supported 1295fa884345SJonathan Cameron */ 1296fa884345SJonathan Cameron if (rc && (mbox_cmd.return_code != CXL_MBOX_CMD_RC_UNSUPPORTED)) 1297fa884345SJonathan Cameron return rc; 1298fa884345SJonathan Cameron 1299fa884345SJonathan Cameron return 0; 1300fa884345SJonathan Cameron } 1301fa884345SJonathan Cameron EXPORT_SYMBOL_NS_GPL(cxl_set_timestamp, CXL); 1302fa884345SJonathan Cameron 1303ed83f7caSAlison Schofield int cxl_mem_get_poison(struct cxl_memdev *cxlmd, u64 offset, u64 len, 1304ed83f7caSAlison Schofield struct cxl_region *cxlr) 1305ed83f7caSAlison Schofield { 130659f8d151SDan Williams struct cxl_memdev_state *mds = to_cxl_memdev_state(cxlmd->cxlds); 1307ed83f7caSAlison Schofield struct cxl_mbox_poison_out *po; 1308ed83f7caSAlison Schofield struct cxl_mbox_poison_in pi; 1309ed83f7caSAlison Schofield int nr_records = 0; 1310ed83f7caSAlison Schofield int rc; 1311ed83f7caSAlison Schofield 131259f8d151SDan Williams rc = mutex_lock_interruptible(&mds->poison.lock); 1313ed83f7caSAlison Schofield if (rc) 1314ed83f7caSAlison Schofield return rc; 1315ed83f7caSAlison Schofield 131659f8d151SDan Williams po = mds->poison.list_out; 1317ed83f7caSAlison Schofield pi.offset = cpu_to_le64(offset); 1318ed83f7caSAlison Schofield pi.length = cpu_to_le64(len / CXL_POISON_LEN_MULT); 1319ed83f7caSAlison Schofield 13204b759dd5SDan Williams do { 13214b759dd5SDan Williams struct cxl_mbox_cmd mbox_cmd = (struct cxl_mbox_cmd){ 1322ed83f7caSAlison Schofield .opcode = CXL_MBOX_OP_GET_POISON, 1323ed83f7caSAlison Schofield .size_in = sizeof(pi), 1324ed83f7caSAlison Schofield .payload_in = &pi, 132559f8d151SDan Williams .size_out = mds->payload_size, 1326ed83f7caSAlison Schofield .payload_out = po, 1327ed83f7caSAlison Schofield .min_out = struct_size(po, record, 0), 1328ed83f7caSAlison Schofield }; 1329ed83f7caSAlison Schofield 133059f8d151SDan Williams rc = cxl_internal_send_cmd(mds, &mbox_cmd); 1331ed83f7caSAlison Schofield if (rc) 1332ed83f7caSAlison Schofield break; 1333ed83f7caSAlison Schofield 1334ddf49d57SAlison Schofield for (int i = 0; i < le16_to_cpu(po->count); i++) 1335ddf49d57SAlison Schofield trace_cxl_poison(cxlmd, cxlr, &po->record[i], 1336ddf49d57SAlison Schofield po->flags, po->overflow_ts, 1337ddf49d57SAlison Schofield CXL_POISON_TRACE_LIST); 1338ed83f7caSAlison Schofield 1339ed83f7caSAlison Schofield /* Protect against an uncleared _FLAG_MORE */ 1340ed83f7caSAlison Schofield nr_records = nr_records + le16_to_cpu(po->count); 134159f8d151SDan Williams if (nr_records >= mds->poison.max_errors) { 1342ed83f7caSAlison Schofield dev_dbg(&cxlmd->dev, "Max Error Records reached: %d\n", 1343ed83f7caSAlison Schofield nr_records); 1344ed83f7caSAlison Schofield break; 1345ed83f7caSAlison Schofield } 1346ed83f7caSAlison Schofield } while (po->flags & CXL_POISON_FLAG_MORE); 1347ed83f7caSAlison Schofield 134859f8d151SDan Williams mutex_unlock(&mds->poison.lock); 1349ed83f7caSAlison Schofield return rc; 1350ed83f7caSAlison Schofield } 1351ed83f7caSAlison Schofield EXPORT_SYMBOL_NS_GPL(cxl_mem_get_poison, CXL); 1352ed83f7caSAlison Schofield 1353d0abf578SAlison Schofield static void free_poison_buf(void *buf) 1354d0abf578SAlison Schofield { 1355d0abf578SAlison Schofield kvfree(buf); 1356d0abf578SAlison Schofield } 1357d0abf578SAlison Schofield 135859f8d151SDan Williams /* Get Poison List output buffer is protected by mds->poison.lock */ 135959f8d151SDan Williams static int cxl_poison_alloc_buf(struct cxl_memdev_state *mds) 1360d0abf578SAlison Schofield { 136159f8d151SDan Williams mds->poison.list_out = kvmalloc(mds->payload_size, GFP_KERNEL); 136259f8d151SDan Williams if (!mds->poison.list_out) 1363d0abf578SAlison Schofield return -ENOMEM; 1364d0abf578SAlison Schofield 136559f8d151SDan Williams return devm_add_action_or_reset(mds->cxlds.dev, free_poison_buf, 136659f8d151SDan Williams mds->poison.list_out); 1367d0abf578SAlison Schofield } 1368d0abf578SAlison Schofield 136959f8d151SDan Williams int cxl_poison_state_init(struct cxl_memdev_state *mds) 1370d0abf578SAlison Schofield { 1371d0abf578SAlison Schofield int rc; 1372d0abf578SAlison Schofield 137359f8d151SDan Williams if (!test_bit(CXL_POISON_ENABLED_LIST, mds->poison.enabled_cmds)) 1374d0abf578SAlison Schofield return 0; 1375d0abf578SAlison Schofield 137659f8d151SDan Williams rc = cxl_poison_alloc_buf(mds); 1377d0abf578SAlison Schofield if (rc) { 137859f8d151SDan Williams clear_bit(CXL_POISON_ENABLED_LIST, mds->poison.enabled_cmds); 1379d0abf578SAlison Schofield return rc; 1380d0abf578SAlison Schofield } 1381d0abf578SAlison Schofield 138259f8d151SDan Williams mutex_init(&mds->poison.lock); 1383d0abf578SAlison Schofield return 0; 1384d0abf578SAlison Schofield } 1385d0abf578SAlison Schofield EXPORT_SYMBOL_NS_GPL(cxl_poison_state_init, CXL); 1386d0abf578SAlison Schofield 138759f8d151SDan Williams struct cxl_memdev_state *cxl_memdev_state_create(struct device *dev) 13884faf31b4SDan Williams { 138959f8d151SDan Williams struct cxl_memdev_state *mds; 13904faf31b4SDan Williams 139159f8d151SDan Williams mds = devm_kzalloc(dev, sizeof(*mds), GFP_KERNEL); 139259f8d151SDan Williams if (!mds) { 13934faf31b4SDan Williams dev_err(dev, "No memory available\n"); 13944faf31b4SDan Williams return ERR_PTR(-ENOMEM); 13954faf31b4SDan Williams } 13964faf31b4SDan Williams 139759f8d151SDan Williams mutex_init(&mds->mbox_mutex); 139859f8d151SDan Williams mutex_init(&mds->event.log_lock); 139959f8d151SDan Williams mds->cxlds.dev = dev; 14002dd18279SRobert Richter mds->cxlds.reg_map.host = dev; 14012dd18279SRobert Richter mds->cxlds.reg_map.resource = CXL_RESOURCE_NONE; 1402f6b8ab32SDan Williams mds->cxlds.type = CXL_DEVTYPE_CLASSMEM; 140300413c15SDave Jiang mds->ram_perf.qos_class = CXL_QOS_CLASS_INVALID; 140400413c15SDave Jiang mds->pmem_perf.qos_class = CXL_QOS_CLASS_INVALID; 14054faf31b4SDan Williams 140659f8d151SDan Williams return mds; 14074faf31b4SDan Williams } 140859f8d151SDan Williams EXPORT_SYMBOL_NS_GPL(cxl_memdev_state_create, CXL); 14094faf31b4SDan Williams 14104faf31b4SDan Williams void __init cxl_mbox_init(void) 14114faf31b4SDan Williams { 14124faf31b4SDan Williams struct dentry *mbox_debugfs; 14134faf31b4SDan Williams 14149b99ecf5SDan Williams mbox_debugfs = cxl_debugfs_create_dir("mbox"); 14154faf31b4SDan Williams debugfs_create_bool("raw_allow_all", 0600, mbox_debugfs, 14164faf31b4SDan Williams &cxl_raw_allow_all); 14174faf31b4SDan Williams } 1418