drivers/acpi/pfr_telemetry.c

   1 // SPDX-License-Identifier: GPL-2.0
   2 /*
   3  * ACPI Platform Firmware Runtime Telemetry driver
   4  *
   5  * Copyright (C) 2021 Intel Corporation
   6  * Author: Chen Yu <yu.c.chen@intel.com>
   7  *
   8  * This driver allows user space to fetch telemetry data from the
   9  * firmware with the help of the Platform Firmware Runtime Telemetry
  10  * interface.
  11  */
  12 #include <linux/acpi.h>
  13 #include <linux/device.h>
  14 #include <linux/err.h>
  15 #include <linux/errno.h>
  16 #include <linux/file.h>
  17 #include <linux/fs.h>
  18 #include <linux/miscdevice.h>
  19 #include <linux/module.h>
  20 #include <linux/mm.h>
  21 #include <linux/platform_device.h>
  22 #include <linux/string.h>
  23 #include <linux/uaccess.h>
  24 #include <linux/uio.h>
  25 #include <linux/uuid.h>
  26
  27 #include <uapi/linux/pfrut.h>
  28
  29 #define PFRT_LOG_EXEC_IDX       0
  30 #define PFRT_LOG_HISTORY_IDX    1
  31
  32 #define PFRT_LOG_ERR            0
  33 #define PFRT_LOG_WARN   1
  34 #define PFRT_LOG_INFO   2
  35 #define PFRT_LOG_VERB   4
  36
  37 #define PFRT_FUNC_SET_LEV               1
  38 #define PFRT_FUNC_GET_LEV               2
  39 #define PFRT_FUNC_GET_DATA              3
  40
  41 #define PFRT_REVID_1            1
  42 #define PFRT_REVID_2            2
  43 #define PFRT_DEFAULT_REV_ID     PFRT_REVID_1
  44
  45 enum log_index {
  46         LOG_STATUS_IDX = 0,
  47         LOG_EXT_STATUS_IDX = 1,
  48         LOG_MAX_SZ_IDX = 2,
  49         LOG_CHUNK1_LO_IDX = 3,
  50         LOG_CHUNK1_HI_IDX = 4,
  51         LOG_CHUNK1_SZ_IDX = 5,
  52         LOG_CHUNK2_LO_IDX = 6,
  53         LOG_CHUNK2_HI_IDX = 7,
  54         LOG_CHUNK2_SZ_IDX = 8,
  55         LOG_ROLLOVER_CNT_IDX = 9,
  56         LOG_RESET_CNT_IDX = 10,
  57         LOG_NR_IDX
  58 };
  59
  60 struct pfrt_log_device {
  61         int index;
  62         struct pfrt_log_info info;
  63         struct device *parent_dev;
  64         struct miscdevice miscdev;
  65 };
  66
  67 /* pfrt_guid is the parameter for _DSM method */
  68 static const guid_t pfrt_log_guid =
  69         GUID_INIT(0x75191659, 0x8178, 0x4D9D, 0xB8, 0x8F, 0xAC, 0x5E,
  70                   0x5E, 0x93, 0xE8, 0xBF);
  71
  72 static DEFINE_IDA(pfrt_log_ida);
  73
  74 static inline struct pfrt_log_device *to_pfrt_log_dev(struct file *file)
  75 {
  76         return container_of(file->private_data, struct pfrt_log_device, miscdev);
  77 }
  78
  79 static int get_pfrt_log_data_info(struct pfrt_log_data_info *data_info,
  80                                   struct pfrt_log_device *pfrt_log_dev)
  81 {
  82         acpi_handle handle = ACPI_HANDLE(pfrt_log_dev->parent_dev);
  83         union acpi_object *out_obj, in_obj, in_buf;
  84         int ret = -EBUSY;
  85
  86         memset(&in_obj, 0, sizeof(in_obj));
  87         memset(&in_buf, 0, sizeof(in_buf));
  88         in_obj.type = ACPI_TYPE_PACKAGE;
  89         in_obj.package.count = 1;
  90         in_obj.package.elements = &in_buf;
  91         in_buf.type = ACPI_TYPE_INTEGER;
  92         in_buf.integer.value = pfrt_log_dev->info.log_type;
  93
  94         out_obj = acpi_evaluate_dsm_typed(handle, &pfrt_log_guid,
  95                                           pfrt_log_dev->info.log_revid, PFRT_FUNC_GET_DATA,
  96                                           &in_obj, ACPI_TYPE_PACKAGE);
  97         if (!out_obj)
  98                 return -EINVAL;
  99
 100         if (out_obj->package.count < LOG_NR_IDX ||
 101             out_obj->package.elements[LOG_STATUS_IDX].type != ACPI_TYPE_INTEGER ||
 102             out_obj->package.elements[LOG_EXT_STATUS_IDX].type != ACPI_TYPE_INTEGER ||
 103             out_obj->package.elements[LOG_MAX_SZ_IDX].type != ACPI_TYPE_INTEGER ||
 104             out_obj->package.elements[LOG_CHUNK1_LO_IDX].type != ACPI_TYPE_INTEGER ||
 105             out_obj->package.elements[LOG_CHUNK1_HI_IDX].type != ACPI_TYPE_INTEGER ||
 106             out_obj->package.elements[LOG_CHUNK1_SZ_IDX].type != ACPI_TYPE_INTEGER ||
 107             out_obj->package.elements[LOG_CHUNK2_LO_IDX].type != ACPI_TYPE_INTEGER ||
 108             out_obj->package.elements[LOG_CHUNK2_HI_IDX].type != ACPI_TYPE_INTEGER ||
 109             out_obj->package.elements[LOG_CHUNK2_SZ_IDX].type != ACPI_TYPE_INTEGER ||
 110             out_obj->package.elements[LOG_ROLLOVER_CNT_IDX].type != ACPI_TYPE_INTEGER ||
 111             out_obj->package.elements[LOG_RESET_CNT_IDX].type != ACPI_TYPE_INTEGER)
 112                 goto free_acpi_buffer;
 113
 114         data_info->status = out_obj->package.elements[LOG_STATUS_IDX].integer.value;
 115         data_info->ext_status =
 116                 out_obj->package.elements[LOG_EXT_STATUS_IDX].integer.value;
 117         if (data_info->status != DSM_SUCCEED) {
 118                 dev_dbg(pfrt_log_dev->parent_dev, "Error Status:%d\n", data_info->status);
 119                 dev_dbg(pfrt_log_dev->parent_dev, "Error Extend Status:%d\n",
 120                         data_info->ext_status);
 121                 goto free_acpi_buffer;
 122         }
 123
 124         data_info->max_data_size =
 125                 out_obj->package.elements[LOG_MAX_SZ_IDX].integer.value;
 126         data_info->chunk1_addr_lo =
 127                 out_obj->package.elements[LOG_CHUNK1_LO_IDX].integer.value;
 128         data_info->chunk1_addr_hi =
 129                 out_obj->package.elements[LOG_CHUNK1_HI_IDX].integer.value;
 130         data_info->chunk1_size =
 131                 out_obj->package.elements[LOG_CHUNK1_SZ_IDX].integer.value;
 132         data_info->chunk2_addr_lo =
 133                 out_obj->package.elements[LOG_CHUNK2_LO_IDX].integer.value;
 134         data_info->chunk2_addr_hi =
 135                 out_obj->package.elements[LOG_CHUNK2_HI_IDX].integer.value;
 136         data_info->chunk2_size =
 137                 out_obj->package.elements[LOG_CHUNK2_SZ_IDX].integer.value;
 138         data_info->rollover_cnt =
 139                 out_obj->package.elements[LOG_ROLLOVER_CNT_IDX].integer.value;
 140         data_info->reset_cnt =
 141                 out_obj->package.elements[LOG_RESET_CNT_IDX].integer.value;
 142
 143         ret = 0;
 144
 145 free_acpi_buffer:
 146         kfree(out_obj);
 147
 148         return ret;
 149 }
 150
 151 static int set_pfrt_log_level(int level, struct pfrt_log_device *pfrt_log_dev)
 152 {
 153         acpi_handle handle = ACPI_HANDLE(pfrt_log_dev->parent_dev);
 154         union acpi_object *out_obj, *obj, in_obj, in_buf;
 155         enum pfru_dsm_status status, ext_status;
 156         int ret = 0;
 157
 158         memset(&in_obj, 0, sizeof(in_obj));
 159         memset(&in_buf, 0, sizeof(in_buf));
 160         in_obj.type = ACPI_TYPE_PACKAGE;
 161         in_obj.package.count = 1;
 162         in_obj.package.elements = &in_buf;
 163         in_buf.type = ACPI_TYPE_INTEGER;
 164         in_buf.integer.value = level;
 165
 166         out_obj = acpi_evaluate_dsm_typed(handle, &pfrt_log_guid,
 167                                           pfrt_log_dev->info.log_revid, PFRT_FUNC_SET_LEV,
 168                                           &in_obj, ACPI_TYPE_PACKAGE);
 169         if (!out_obj)
 170                 return -EINVAL;
 171
 172         obj = &out_obj->package.elements[0];
 173         status = obj->integer.value;
 174         if (status != DSM_SUCCEED) {
 175                 obj = &out_obj->package.elements[1];
 176                 ext_status = obj->integer.value;
 177                 dev_dbg(pfrt_log_dev->parent_dev, "Error Status:%d\n", status);
 178                 dev_dbg(pfrt_log_dev->parent_dev, "Error Extend Status:%d\n", ext_status);
 179                 ret = -EBUSY;
 180         }
 181
 182         kfree(out_obj);
 183
 184         return ret;
 185 }
 186
 187 static int get_pfrt_log_level(struct pfrt_log_device *pfrt_log_dev)
 188 {
 189         acpi_handle handle = ACPI_HANDLE(pfrt_log_dev->parent_dev);
 190         union acpi_object *out_obj, *obj;
 191         enum pfru_dsm_status status, ext_status;
 192         int ret = -EBUSY;
 193
 194         out_obj = acpi_evaluate_dsm_typed(handle, &pfrt_log_guid,
 195                                           pfrt_log_dev->info.log_revid, PFRT_FUNC_GET_LEV,
 196                                           NULL, ACPI_TYPE_PACKAGE);
 197         if (!out_obj)
 198                 return -EINVAL;
 199
 200         obj = &out_obj->package.elements[0];
 201         if (obj->type != ACPI_TYPE_INTEGER)
 202                 goto free_acpi_buffer;
 203
 204         status = obj->integer.value;
 205         if (status != DSM_SUCCEED) {
 206                 obj = &out_obj->package.elements[1];
 207                 ext_status = obj->integer.value;
 208                 dev_dbg(pfrt_log_dev->parent_dev, "Error Status:%d\n", status);
 209                 dev_dbg(pfrt_log_dev->parent_dev, "Error Extend Status:%d\n", ext_status);
 210                 goto free_acpi_buffer;
 211         }
 212
 213         obj = &out_obj->package.elements[2];
 214         if (obj->type != ACPI_TYPE_INTEGER)
 215                 goto free_acpi_buffer;
 216
 217         ret = obj->integer.value;
 218
 219 free_acpi_buffer:
 220         kfree(out_obj);
 221
 222         return ret;
 223 }
 224
 225 static int valid_log_level(u32 level)
 226 {
 227         return level == PFRT_LOG_ERR || level == PFRT_LOG_WARN ||
 228                level == PFRT_LOG_INFO || level == PFRT_LOG_VERB;
 229 }
 230
 231 static int valid_log_type(u32 type)
 232 {
 233         return type == PFRT_LOG_EXEC_IDX || type == PFRT_LOG_HISTORY_IDX;
 234 }
 235
 236 static inline int valid_log_revid(u32 id)
 237 {
 238         return id == PFRT_REVID_1 || id == PFRT_REVID_2;
 239 }
 240
 241 static long pfrt_log_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
 242 {
 243         struct pfrt_log_device *pfrt_log_dev = to_pfrt_log_dev(file);
 244         struct pfrt_log_data_info data_info;
 245         struct pfrt_log_info info;
 246         void __user *p;
 247         int ret = 0;
 248
 249         p = (void __user *)arg;
 250
 251         switch (cmd) {
 252         case PFRT_LOG_IOC_SET_INFO:
 253                 if (copy_from_user(&info, p, sizeof(info)))
 254                         return -EFAULT;
 255
 256                 if (valid_log_revid(info.log_revid))
 257                         pfrt_log_dev->info.log_revid = info.log_revid;
 258
 259                 if (valid_log_level(info.log_level)) {
 260                         ret = set_pfrt_log_level(info.log_level, pfrt_log_dev);
 261                         if (ret < 0)
 262                                 return ret;
 263
 264                         pfrt_log_dev->info.log_level = info.log_level;
 265                 }
 266
 267                 if (valid_log_type(info.log_type))
 268                         pfrt_log_dev->info.log_type = info.log_type;
 269
 270                 return 0;
 271
 272         case PFRT_LOG_IOC_GET_INFO:
 273                 info.log_level = get_pfrt_log_level(pfrt_log_dev);
 274                 if (ret < 0)
 275                         return ret;
 276
 277                 info.log_type = pfrt_log_dev->info.log_type;
 278                 info.log_revid = pfrt_log_dev->info.log_revid;
 279                 if (copy_to_user(p, &info, sizeof(info)))
 280                         return -EFAULT;
 281
 282                 return 0;
 283
 284         case PFRT_LOG_IOC_GET_DATA_INFO:
 285                 ret = get_pfrt_log_data_info(&data_info, pfrt_log_dev);
 286                 if (ret)
 287                         return ret;
 288
 289                 if (copy_to_user(p, &data_info, sizeof(struct pfrt_log_data_info)))
 290                         return -EFAULT;
 291
 292                 return 0;
 293
 294         default:
 295                 return -ENOTTY;
 296         }
 297 }
 298
 299 static int
 300 pfrt_log_mmap(struct file *file, struct vm_area_struct *vma)
 301 {
 302         struct pfrt_log_device *pfrt_log_dev;
 303         struct pfrt_log_data_info info;
 304         unsigned long psize, vsize;
 305         phys_addr_t base_addr;
 306         int ret;
 307
 308         if (vma->vm_flags & VM_WRITE)
 309                 return -EROFS;
 310
 311         /* changing from read to write with mprotect is not allowed */
 312         vma->vm_flags &= ~VM_MAYWRITE;
 313
 314         pfrt_log_dev = to_pfrt_log_dev(file);
 315
 316         ret = get_pfrt_log_data_info(&info, pfrt_log_dev);
 317         if (ret)
 318                 return ret;
 319
 320         base_addr = (phys_addr_t)((info.chunk2_addr_hi << 32) | info.chunk2_addr_lo);
 321         /* pfrt update has not been launched yet */
 322         if (!base_addr)
 323                 return -ENODEV;
 324
 325         psize = info.max_data_size;
 326         /* base address and total buffer size must be page aligned */
 327         if (!PAGE_ALIGNED(base_addr) || !PAGE_ALIGNED(psize))
 328                 return -ENODEV;
 329
 330         vsize = vma->vm_end - vma->vm_start;
 331         if (vsize > psize)
 332                 return -EINVAL;
 333
 334         vma->vm_page_prot = pgprot_noncached(vma->vm_page_prot);
 335         if (io_remap_pfn_range(vma, vma->vm_start, PFN_DOWN(base_addr),
 336                                vsize, vma->vm_page_prot))
 337                 return -EAGAIN;
 338
 339         return 0;
 340 }
 341
 342 static const struct file_operations acpi_pfrt_log_fops = {
 343         .owner          = THIS_MODULE,
 344         .mmap           = pfrt_log_mmap,
 345         .unlocked_ioctl = pfrt_log_ioctl,
 346         .llseek         = noop_llseek,
 347 };
 348
 349 static int acpi_pfrt_log_remove(struct platform_device *pdev)
 350 {
 351         struct pfrt_log_device *pfrt_log_dev = platform_get_drvdata(pdev);
 352
 353         misc_deregister(&pfrt_log_dev->miscdev);
 354
 355         return 0;
 356 }
 357
 358 static void pfrt_log_put_idx(void *data)
 359 {
 360         struct pfrt_log_device *pfrt_log_dev = data;
 361
 362         ida_free(&pfrt_log_ida, pfrt_log_dev->index);
 363 }
 364
 365 static int acpi_pfrt_log_probe(struct platform_device *pdev)
 366 {
 367         acpi_handle handle = ACPI_HANDLE(&pdev->dev);
 368         struct pfrt_log_device *pfrt_log_dev;
 369         int ret;
 370
 371         if (!acpi_has_method(handle, "_DSM")) {
 372                 dev_dbg(&pdev->dev, "Missing _DSM\n");
 373                 return -ENODEV;
 374         }
 375
 376         pfrt_log_dev = devm_kzalloc(&pdev->dev, sizeof(*pfrt_log_dev), GFP_KERNEL);
 377         if (!pfrt_log_dev)
 378                 return -ENOMEM;
 379
 380         ret = ida_alloc(&pfrt_log_ida, GFP_KERNEL);
 381         if (ret < 0)
 382                 return ret;
 383
 384         pfrt_log_dev->index = ret;
 385         ret = devm_add_action_or_reset(&pdev->dev, pfrt_log_put_idx, pfrt_log_dev);
 386         if (ret)
 387                 return ret;
 388
 389         pfrt_log_dev->info.log_revid = PFRT_DEFAULT_REV_ID;
 390         pfrt_log_dev->parent_dev = &pdev->dev;
 391
 392         pfrt_log_dev->miscdev.minor = MISC_DYNAMIC_MINOR;
 393         pfrt_log_dev->miscdev.name = devm_kasprintf(&pdev->dev, GFP_KERNEL,
 394                                                     "pfrt%d",
 395                                                     pfrt_log_dev->index);
 396         if (!pfrt_log_dev->miscdev.name)
 397                 return -ENOMEM;
 398
 399         pfrt_log_dev->miscdev.nodename = devm_kasprintf(&pdev->dev, GFP_KERNEL,
 400                                                         "acpi_pfr_telemetry%d",
 401                                                         pfrt_log_dev->index);
 402         if (!pfrt_log_dev->miscdev.nodename)
 403                 return -ENOMEM;
 404
 405         pfrt_log_dev->miscdev.fops = &acpi_pfrt_log_fops;
 406         pfrt_log_dev->miscdev.parent = &pdev->dev;
 407
 408         ret = misc_register(&pfrt_log_dev->miscdev);
 409         if (ret)
 410                 return ret;
 411
 412         platform_set_drvdata(pdev, pfrt_log_dev);
 413
 414         return 0;
 415 }
 416
 417 static const struct acpi_device_id acpi_pfrt_log_ids[] = {
 418         {"INTC1081"},
 419         {}
 420 };
 421 MODULE_DEVICE_TABLE(acpi, acpi_pfrt_log_ids);
 422
 423 static struct platform_driver acpi_pfrt_log_driver = {
 424         .driver = {
 425                 .name = "pfr_telemetry",
 426                 .acpi_match_table = acpi_pfrt_log_ids,
 427         },
 428         .probe = acpi_pfrt_log_probe,
 429         .remove = acpi_pfrt_log_remove,
 430 };
 431 module_platform_driver(acpi_pfrt_log_driver);
 432
 433 MODULE_DESCRIPTION("Platform Firmware Runtime Update Telemetry driver");
 434 MODULE_LICENSE("GPL v2");