^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 1) // SPDX-License-Identifier: GPL-2.0 OR BSD-2-Clause
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 2) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 3) * Copyright (C) 2020 VMware, Inc., Palo Alto, CA., USA
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 4) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 5) * PTP clock driver for VMware precision clock virtual device.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 6) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 7)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 8) #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 9)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 10) #include <linux/acpi.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 11) #include <linux/kernel.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 12) #include <linux/module.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 13) #include <linux/ptp_clock_kernel.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 14) #include <asm/hypervisor.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 15) #include <asm/vmware.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 16)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 17) #define VMWARE_MAGIC 0x564D5868
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 18) #define VMWARE_CMD_PCLK(nr) ((nr << 16) | 97)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 19) #define VMWARE_CMD_PCLK_GETTIME VMWARE_CMD_PCLK(0)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 20)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 21) static struct acpi_device *ptp_vmw_acpi_device;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 22) static struct ptp_clock *ptp_vmw_clock;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 23)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 24)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 25) static int ptp_vmw_pclk_read(u64 *ns)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 26) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 27) u32 ret, nsec_hi, nsec_lo, unused1, unused2, unused3;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 28)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 29) asm volatile (VMWARE_HYPERCALL :
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 30) "=a"(ret), "=b"(nsec_hi), "=c"(nsec_lo), "=d"(unused1),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 31) "=S"(unused2), "=D"(unused3) :
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 32) "a"(VMWARE_MAGIC), "b"(0),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 33) "c"(VMWARE_CMD_PCLK_GETTIME), "d"(0) :
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 34) "memory");
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 35)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 36) if (ret == 0)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 37) *ns = ((u64)nsec_hi << 32) | nsec_lo;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 38) return ret;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 39) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 40)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 41) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 42) * PTP clock ops.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 43) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 44)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 45) static int ptp_vmw_adjtime(struct ptp_clock_info *info, s64 delta)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 46) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 47) return -EOPNOTSUPP;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 48) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 49)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 50) static int ptp_vmw_adjfreq(struct ptp_clock_info *info, s32 delta)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 51) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 52) return -EOPNOTSUPP;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 53) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 54)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 55) static int ptp_vmw_gettime(struct ptp_clock_info *info, struct timespec64 *ts)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 56) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 57) u64 ns;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 58)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 59) if (ptp_vmw_pclk_read(&ns) != 0)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 60) return -EIO;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 61) *ts = ns_to_timespec64(ns);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 62) return 0;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 63) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 64)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 65) static int ptp_vmw_settime(struct ptp_clock_info *info,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 66) const struct timespec64 *ts)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 67) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 68) return -EOPNOTSUPP;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 69) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 70)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 71) static int ptp_vmw_enable(struct ptp_clock_info *info,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 72) struct ptp_clock_request *request, int on)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 73) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 74) return -EOPNOTSUPP;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 75) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 76)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 77) static struct ptp_clock_info ptp_vmw_clock_info = {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 78) .owner = THIS_MODULE,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 79) .name = "ptp_vmw",
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 80) .max_adj = 0,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 81) .adjtime = ptp_vmw_adjtime,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 82) .adjfreq = ptp_vmw_adjfreq,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 83) .gettime64 = ptp_vmw_gettime,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 84) .settime64 = ptp_vmw_settime,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 85) .enable = ptp_vmw_enable,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 86) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 87)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 88) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 89) * ACPI driver ops for VMware "precision clock" virtual device.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 90) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 91)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 92) static int ptp_vmw_acpi_add(struct acpi_device *device)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 93) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 94) ptp_vmw_clock = ptp_clock_register(&ptp_vmw_clock_info, NULL);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 95) if (IS_ERR(ptp_vmw_clock)) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 96) pr_err("failed to register ptp clock\n");
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 97) return PTR_ERR(ptp_vmw_clock);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 98) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 99)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 100) ptp_vmw_acpi_device = device;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 101) return 0;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 102) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 103)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 104) static int ptp_vmw_acpi_remove(struct acpi_device *device)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 105) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 106) ptp_clock_unregister(ptp_vmw_clock);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 107) return 0;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 108) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 109)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 110) static const struct acpi_device_id ptp_vmw_acpi_device_ids[] = {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 111) { "VMW0005", 0 },
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 112) { "", 0 },
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 113) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 114)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 115) MODULE_DEVICE_TABLE(acpi, ptp_vmw_acpi_device_ids);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 116)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 117) static struct acpi_driver ptp_vmw_acpi_driver = {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 118) .name = "ptp_vmw",
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 119) .ids = ptp_vmw_acpi_device_ids,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 120) .ops = {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 121) .add = ptp_vmw_acpi_add,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 122) .remove = ptp_vmw_acpi_remove
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 123) },
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 124) .owner = THIS_MODULE
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 125) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 126)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 127) static int __init ptp_vmw_init(void)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 128) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 129) if (x86_hyper_type != X86_HYPER_VMWARE)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 130) return -1;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 131) return acpi_bus_register_driver(&ptp_vmw_acpi_driver);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 132) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 133)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 134) static void __exit ptp_vmw_exit(void)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 135) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 136) acpi_bus_unregister_driver(&ptp_vmw_acpi_driver);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 137) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 138)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 139) module_init(ptp_vmw_init);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 140) module_exit(ptp_vmw_exit);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 141)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 142) MODULE_DESCRIPTION("VMware virtual PTP clock driver");
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 143) MODULE_AUTHOR("VMware, Inc.");
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 144) MODULE_LICENSE("Dual BSD/GPL");