xref: /freebsd/sys/dev/superio/superio.h (revision 2008043f386721d58158e37e0d7e50df8095942d)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause
3  *
4  * Copyright (c) 2019 Andriy Gapon
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  *
15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25  * SUCH DAMAGE.
26  */
27 
28 #ifndef SUPERIO_H
29 #define SUPERIO_H
30 
31 typedef enum superio_vendor {
32 	SUPERIO_VENDOR_NONE,
33 	SUPERIO_VENDOR_ITE,
34 	SUPERIO_VENDOR_NUVOTON,
35 	SUPERIO_VENDOR_FINTEK,
36 	SUPERIO_VENDOR_MAX
37 } superio_vendor_t;
38 
39 typedef enum superio_dev_type {
40 	SUPERIO_DEV_NONE,
41 	SUPERIO_DEV_HWM,
42 	SUPERIO_DEV_WDT,
43 	SUPERIO_DEV_GPIO,
44 	SUPERIO_DEV_MAX
45 } superio_dev_type_t;
46 
47 superio_vendor_t superio_vendor(device_t dev);
48 uint16_t superio_devid(device_t dev);
49 uint8_t superio_revid(device_t dev);
50 int superio_extid(device_t dev);
51 uint8_t superio_read(device_t dev, uint8_t reg);
52 uint8_t superio_ldn_read(device_t dev, uint8_t ldn, uint8_t reg);
53 void superio_write(device_t dev, uint8_t reg, uint8_t val);
54 void superio_ldn_write(device_t dev, uint8_t ldn, uint8_t reg, uint8_t val);
55 bool superio_dev_enabled(device_t dev, uint8_t mask);
56 void superio_dev_enable(device_t dev, uint8_t mask);
57 void superio_dev_disable(device_t dev, uint8_t mask);
58 
59 device_t superio_find_dev(device_t superio, superio_dev_type_t type,
60     int ldn);
61 
62 enum superio_ivars {
63 	SUPERIO_IVAR_LDN =	10600,
64 	SUPERIO_IVAR_TYPE,
65 	SUPERIO_IVAR_IOBASE,
66 	SUPERIO_IVAR_IOBASE2,
67 	SUPERIO_IVAR_IRQ,
68 	SUPERIO_IVAR_DMA
69 };
70 
71 #define	SUPERIO_ACCESSOR(var, ivar, type)				\
72 	__BUS_ACCESSOR(superio, var, SUPERIO, ivar, type)
73 
74 SUPERIO_ACCESSOR(ldn,		LDN,		uint8_t)
75 SUPERIO_ACCESSOR(type,		TYPE,		superio_dev_type_t)
76 SUPERIO_ACCESSOR(iobase,	IOBASE,		uint16_t)
77 SUPERIO_ACCESSOR(iobase2,	IOBASE2,	uint16_t)
78 SUPERIO_ACCESSOR(irq,		IRQ,		uint8_t)
79 SUPERIO_ACCESSOR(dma,		DMA,		uint8_t)
80 
81 #undef SUPERIO_ACCESSOR
82 
83 #endif /*SUPERIO_H*/
84