xref: /freebsd/sys/dev/tpm/tpm_if.m (revision e9ac41698b2f322d55ccf9da50a3596edb2c1800)
1#-
2# Copyright (c) 2023 Juniper Networks, Inc.
3# All Rights Reserved
4#
5# Redistribution and use in source and binary forms, with or without
6# modification, are permitted provided that the following conditions
7# are met:
8# 1. Redistributions of source code must retain the above copyright
9#    notice, this list of conditions and the following disclaimer.
10# 2. Redistributions in binary form must reproduce the above copyright
11#    notice, this list of conditions and the following disclaimer in the
12#    documentation and/or other materials provided with the distribution.
13#
14# THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17# ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20# OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21# HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23# OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24# SUCH DAMAGE.
25#
26#
27
28#include <sys/bus.h>
29#include <dev/tpm/tpm20.h>
30
31INTERFACE tpm;
32
33#
34# Transfer data to the TPM data buffer
35#
36METHOD int transmit {
37	device_t dev;
38	size_t length;
39};
40
41
42METHOD uint64_t read_8 {
43	device_t dev;
44	bus_size_t addr;
45}
46
47#
48# Read 4 bytes (host endian) from a TPM register
49#
50METHOD uint32_t read_4 {
51	device_t dev;
52	bus_size_t addr;
53};
54
55METHOD uint8_t read_1 {
56	device_t dev;
57	bus_size_t addr;
58};
59
60METHOD void write_4 {
61	device_t dev;
62	bus_size_t addr;
63	uint32_t value;
64};
65
66METHOD void write_1 {
67	device_t dev;
68	bus_size_t addr;
69	uint8_t value;
70};
71
72METHOD void write_barrier {
73	device_t dev;
74	bus_size_t off;
75	bus_size_t length;
76}
77