xref: /freebsd/sys/dev/thunderbolt/tb_if.m (revision c4fde87a3236b500246d4fce76dbca2a3d64f73a)
1#-
2# SPDX-License-Identifier: BSD-2-Clause-FreeBSD
3#
4# Copyright (c) 2022 Scott Long
5# All rights reserved.
6#
7# Redistribution and use in source and binary forms, with or without
8# modification, are permitted provided that the following conditions
9# are met:
10# 1. Redistributions of source code must retain the above copyright
11#    notice, this list of conditions and the following disclaimer.
12# 2. Redistributions in binary form must reproduce the above copyright
13#    notice, this list of conditions and the following disclaimer in the
14#    documentation and/or other materials provided with the distribution.
15#
16# THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19# ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22# OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23# HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25# OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26# SUCH DAMAGE.
27#
28
29#include <sys/bus.h>
30#include <sys/types.h>
31#include <dev/thunderbolt/tb_reg.h>
32
33INTERFACE tb;
34
35CODE {
36	struct nhi_softc;
37
38	int
39	tb_generic_find_ufp(device_t dev, device_t *ufp)
40	{
41		device_t parent;
42
43		parent = device_get_parent(dev);
44		if (parent == NULL)
45			return (EOPNOTSUPP);
46
47		return (TB_FIND_UFP(parent, ufp));
48	}
49
50	int
51	tb_generic_get_debug(device_t dev, u_int *debug)
52	{
53		device_t parent;
54
55		parent = device_get_parent(dev);
56		if (parent == NULL)
57			return (EOPNOTSUPP);
58
59		return (TB_GET_DEBUG(parent, debug));
60	}
61
62}
63
64HEADER {
65	struct nhi_softc;
66
67	struct tb_lcmbox_cmd {
68		uint32_t cmd;
69		uint32_t cmd_resp;
70		uint32_t data_in;
71		uint32_t data_out;
72	};
73
74	int tb_generic_find_ufp(device_t, device_t *);
75	int tb_generic_get_debug(device_t, u_int *);
76}
77
78#
79# Read the LC Mailbox
80#
81METHOD int lc_mailbox {
82	device_t	dev;
83	struct tb_lcmbox_cmd	*cmd;
84};
85
86#
87# Read from the PCIE2CIO port
88#
89METHOD int pcie2cio_read {
90	device_t	dev;
91	u_int		space;
92	u_int		port;
93	u_int		index;
94	uint32_t	*val;
95}
96
97#
98# Write to the PCIE2CIO port
99#
100METHOD int pcie2cio_write {
101	device_t	dev;
102	u_int		space;
103	u_int		port;
104	u_int		index;
105	uint32_t	val;
106}
107
108#
109# Return the device that's the upstream facing port
110#
111METHOD int find_ufp {
112	device_t dev;
113	device_t *ufp;
114} DEFAULT tb_generic_find_ufp;
115
116METHOD int get_debug {
117	device_t dev;
118	u_int *debug;
119} DEFAULT tb_generic_get_debug;
120