mirror of
https://git.kernel.org/pub/scm/linux/kernel/git/herbert/cryptodev-2.6.git
synced 2026-04-21 04:53:46 -04:00
0623c75927
Add the virtio_rtc module and driver core. The virtio_rtc module implements a driver compatible with the proposed Virtio RTC device specification. The Virtio RTC (Real Time Clock) device provides information about current time. The device can provide different clocks, e.g. for the UTC or TAI time standards, or for physical time elapsed since some past epoch. The driver can read the clocks with simple or more accurate methods. Implement the core, which interacts with the Virtio RTC device. Apart from this, the core does not expose functionality outside of the virtio_rtc module. Follow-up patches will expose PTP clocks and an RTC Class device. Provide synchronous messaging, which is enough for the expected time synchronization use cases through PTP clocks (similar to ptp_kvm) or RTC Class device. Signed-off-by: Peter Hilber <quic_philber@quicinc.com> Message-Id: <20250509160734.1772-2-quic_philber@quicinc.com> Signed-off-by: Michael S. Tsirkin <mst@redhat.com>
152 lines
3.4 KiB
C
152 lines
3.4 KiB
C
/* SPDX-License-Identifier: ((GPL-2.0+ WITH Linux-syscall-note) OR BSD-3-Clause) */
|
|
/*
|
|
* Copyright (C) 2022-2024 OpenSynergy GmbH
|
|
* Copyright (c) 2024 Qualcomm Innovation Center, Inc. All rights reserved.
|
|
*/
|
|
|
|
#ifndef _LINUX_VIRTIO_RTC_H
|
|
#define _LINUX_VIRTIO_RTC_H
|
|
|
|
#include <linux/types.h>
|
|
|
|
/* read request message types */
|
|
|
|
#define VIRTIO_RTC_REQ_READ 0x0001
|
|
#define VIRTIO_RTC_REQ_READ_CROSS 0x0002
|
|
|
|
/* control request message types */
|
|
|
|
#define VIRTIO_RTC_REQ_CFG 0x1000
|
|
#define VIRTIO_RTC_REQ_CLOCK_CAP 0x1001
|
|
#define VIRTIO_RTC_REQ_CROSS_CAP 0x1002
|
|
|
|
/* Message headers */
|
|
|
|
/** common request header */
|
|
struct virtio_rtc_req_head {
|
|
__le16 msg_type;
|
|
__u8 reserved[6];
|
|
};
|
|
|
|
/** common response header */
|
|
struct virtio_rtc_resp_head {
|
|
#define VIRTIO_RTC_S_OK 0
|
|
#define VIRTIO_RTC_S_EOPNOTSUPP 2
|
|
#define VIRTIO_RTC_S_ENODEV 3
|
|
#define VIRTIO_RTC_S_EINVAL 4
|
|
#define VIRTIO_RTC_S_EIO 5
|
|
__u8 status;
|
|
__u8 reserved[7];
|
|
};
|
|
|
|
/* read requests */
|
|
|
|
/* VIRTIO_RTC_REQ_READ message */
|
|
|
|
struct virtio_rtc_req_read {
|
|
struct virtio_rtc_req_head head;
|
|
__le16 clock_id;
|
|
__u8 reserved[6];
|
|
};
|
|
|
|
struct virtio_rtc_resp_read {
|
|
struct virtio_rtc_resp_head head;
|
|
__le64 clock_reading;
|
|
};
|
|
|
|
/* VIRTIO_RTC_REQ_READ_CROSS message */
|
|
|
|
struct virtio_rtc_req_read_cross {
|
|
struct virtio_rtc_req_head head;
|
|
__le16 clock_id;
|
|
/* Arm Generic Timer Counter-timer Virtual Count Register (CNTVCT_EL0) */
|
|
#define VIRTIO_RTC_COUNTER_ARM_VCT 0
|
|
/* x86 Time-Stamp Counter */
|
|
#define VIRTIO_RTC_COUNTER_X86_TSC 1
|
|
/* Invalid */
|
|
#define VIRTIO_RTC_COUNTER_INVALID 0xFF
|
|
__u8 hw_counter;
|
|
__u8 reserved[5];
|
|
};
|
|
|
|
struct virtio_rtc_resp_read_cross {
|
|
struct virtio_rtc_resp_head head;
|
|
__le64 clock_reading;
|
|
__le64 counter_cycles;
|
|
};
|
|
|
|
/* control requests */
|
|
|
|
/* VIRTIO_RTC_REQ_CFG message */
|
|
|
|
struct virtio_rtc_req_cfg {
|
|
struct virtio_rtc_req_head head;
|
|
/* no request params */
|
|
};
|
|
|
|
struct virtio_rtc_resp_cfg {
|
|
struct virtio_rtc_resp_head head;
|
|
/** # of clocks -> clock ids < num_clocks are valid */
|
|
__le16 num_clocks;
|
|
__u8 reserved[6];
|
|
};
|
|
|
|
/* VIRTIO_RTC_REQ_CLOCK_CAP message */
|
|
|
|
struct virtio_rtc_req_clock_cap {
|
|
struct virtio_rtc_req_head head;
|
|
__le16 clock_id;
|
|
__u8 reserved[6];
|
|
};
|
|
|
|
struct virtio_rtc_resp_clock_cap {
|
|
struct virtio_rtc_resp_head head;
|
|
#define VIRTIO_RTC_CLOCK_UTC 0
|
|
#define VIRTIO_RTC_CLOCK_TAI 1
|
|
#define VIRTIO_RTC_CLOCK_MONOTONIC 2
|
|
#define VIRTIO_RTC_CLOCK_UTC_SMEARED 3
|
|
#define VIRTIO_RTC_CLOCK_UTC_MAYBE_SMEARED 4
|
|
__u8 type;
|
|
#define VIRTIO_RTC_SMEAR_UNSPECIFIED 0
|
|
#define VIRTIO_RTC_SMEAR_NOON_LINEAR 1
|
|
#define VIRTIO_RTC_SMEAR_UTC_SLS 2
|
|
__u8 leap_second_smearing;
|
|
__u8 reserved[6];
|
|
};
|
|
|
|
/* VIRTIO_RTC_REQ_CROSS_CAP message */
|
|
|
|
struct virtio_rtc_req_cross_cap {
|
|
struct virtio_rtc_req_head head;
|
|
__le16 clock_id;
|
|
__u8 hw_counter;
|
|
__u8 reserved[5];
|
|
};
|
|
|
|
struct virtio_rtc_resp_cross_cap {
|
|
struct virtio_rtc_resp_head head;
|
|
#define VIRTIO_RTC_FLAG_CROSS_CAP (1 << 0)
|
|
__u8 flags;
|
|
__u8 reserved[7];
|
|
};
|
|
|
|
/** Union of request types for requestq */
|
|
union virtio_rtc_req_requestq {
|
|
struct virtio_rtc_req_read read;
|
|
struct virtio_rtc_req_read_cross read_cross;
|
|
struct virtio_rtc_req_cfg cfg;
|
|
struct virtio_rtc_req_clock_cap clock_cap;
|
|
struct virtio_rtc_req_cross_cap cross_cap;
|
|
};
|
|
|
|
/** Union of response types for requestq */
|
|
union virtio_rtc_resp_requestq {
|
|
struct virtio_rtc_resp_read read;
|
|
struct virtio_rtc_resp_read_cross read_cross;
|
|
struct virtio_rtc_resp_cfg cfg;
|
|
struct virtio_rtc_resp_clock_cap clock_cap;
|
|
struct virtio_rtc_resp_cross_cap cross_cap;
|
|
};
|
|
|
|
#endif /* _LINUX_VIRTIO_RTC_H */
|