1 /* SPDX-License-Identifier: GPL-2.0-only */
2
3 #ifndef DEVICE_PNP_H
4 #define DEVICE_PNP_H
5
6 #include <stdint.h>
7 #include <device/device.h>
8 /* When <device/pnp.h> is needed, it supposed to provide <device/pnp_{def,type}.h> */
9 #include <device/pnp_def.h> /* IWYU pragma: export */
10 #include <device/pnp_type.h> /* IWYU pragma: export */
11 #include <arch/io.h>
12
13 #if !ENV_PNP_SIMPLE_DEVICE
14
15 /* Primitive PNP resource manipulation */
16 void pnp_write_config(struct device *dev, u8 reg, u8 value);
17 u8 pnp_read_config(struct device *dev, u8 reg);
18 void pnp_unset_and_set_config(struct device *dev, u8 reg, u8 unset, u8 set);
19 void pnp_set_logical_device(struct device *dev);
20 void pnp_set_enable(struct device *dev, int enable);
21 int pnp_read_enable(struct device *dev);
22 void pnp_set_iobase(struct device *dev, u8 index, u16 iobase);
23 void pnp_set_irq(struct device *dev, u8 index, u8 irq);
24 void pnp_set_drq(struct device *dev, u8 index, u8 drq);
25
26 #endif
27
28 /* PNP device operations */
29 void pnp_read_resources(struct device *dev);
30 void pnp_set_resources(struct device *dev);
31 void pnp_enable_resources(struct device *dev);
32 void pnp_enable(struct device *dev);
33 void pnp_alt_enable(struct device *dev);
34
35 extern struct device_operations pnp_ops;
36
37 /* PNP helper operations */
38
39 struct pnp_info {
40 struct device_operations *ops; /* LDN-specific ops override */
41 #define PNP_SKIP_FUNCTION 0xffff
42 u16 function; /* Must be at least 16 bits (virtual LDNs)! */
43 unsigned int flags;
44 #define PNP_IO0 0x0000001
45 #define PNP_IO1 0x0000002
46 #define PNP_IO2 0x0000004
47 #define PNP_IO3 0x0000008
48 #define PNP_IO4 0x0000010
49 #define PNP_IRQ0 0x0000020
50 #define PNP_IRQ1 0x0000040
51 #define PNP_DRQ0 0x0000080
52 #define PNP_DRQ1 0x0000100
53 #define PNP_EN 0x0000200
54 #define PNP_MSC0 0x0000400
55 #define PNP_MSC1 0x0000800
56 #define PNP_MSC2 0x0001000
57 #define PNP_MSC3 0x0002000
58 #define PNP_MSC4 0x0004000
59 #define PNP_MSC5 0x0008000
60 #define PNP_MSC6 0x0010000
61 #define PNP_MSC7 0x0020000
62 #define PNP_MSC8 0x0040000
63 #define PNP_MSC9 0x0080000
64 #define PNP_MSCA 0x0100000
65 #define PNP_MSCB 0x0200000
66 #define PNP_MSCC 0x0400000
67 #define PNP_MSCD 0x0800000
68 #define PNP_MSCE 0x1000000
69 u16 io0, io1, io2, io3, io4;
70 };
71 struct resource *pnp_get_resource(struct device *dev, unsigned int index);
72 void pnp_enable_devices(struct device *dev, struct device_operations *ops,
73 unsigned int functions, struct pnp_info *info);
74
75 struct pnp_mode_ops {
76 void (*enter_conf_mode)(struct device *dev);
77 void (*exit_conf_mode)(struct device *dev);
78 #if CONFIG(HAVE_ACPI_TABLES)
79 /*
80 * Generates ASL code to enter/exit config mode.
81 *
82 * @param idx The ACPI name of the SuperIO index port register. eg. 'INDX'.
83 * @param data The ACPI name of the SuperIO data port register. eg. 'DATA'.
84 */
85 void (*ssdt_enter_conf_mode)(struct device *dev, const char *idx, const char *data);
86 void (*ssdt_exit_conf_mode)(struct device *dev, const char *idx, const char *data);
87 #endif
88 };
89 void pnp_enter_conf_mode(struct device *dev);
90 void pnp_exit_conf_mode(struct device *dev);
91 #if CONFIG(HAVE_ACPI_TABLES)
92 /*
93 * Generates ASL code to enter/exit config mode if supported.
94 * The calling code has to place this within an ASL MethodOP.
95 *
96 * @param idx The ACPI name of the SuperIO index port register. eg. 'INDX'.
97 * @param data The ACPI name of the SuperIO data port register. eg. 'DATA'.
98 */
99 void pnp_ssdt_enter_conf_mode(struct device *dev, const char *idx, const char *data);
100 void pnp_ssdt_exit_conf_mode(struct device *dev, const char *idx, const char *data);
101 #endif
102 /* PNP indexed I/O operations */
103
104 /*
105 * u8 pnp_read_index(u16 port, u8 reg)
106 * Description:
107 * This routine reads indexed I/O registers. The reg byte is written
108 * to the index register at I/O address = port. The result is then
109 * read from the data register at I/O address = port + 1.
110 *
111 * Parameters:
112 * @param[in] u16 port = The I/O address of the port index register.
113 * @param[in] u8 reg = The offset within the indexed space.
114 * @param[out] u8 result = The value read back from the data register.
115 */
pnp_read_index(u16 port,u8 reg)116 static inline u8 pnp_read_index(u16 port, u8 reg)
117 {
118 outb(reg, port);
119 return inb(port + 1);
120 }
121
122 /*
123 * void pnp_write_index(u16 port, u8 reg, u8 value)
124 * Description:
125 * This routine writes indexed I/O registers. The reg byte is written
126 * to the index register at I/O address = port. The value byte is then
127 * written to the data register at I/O address = port + 1.
128 *
129 * Parameters:
130 * @param[in] u16 port = The address of the port index register.
131 * @param[in] u8 reg = The offset within the indexed space.
132 * @param[in] u8 value = The value to be written to the data register.
133 */
pnp_write_index(u16 port,u8 reg,u8 value)134 static inline void pnp_write_index(u16 port, u8 reg, u8 value)
135 {
136 outb(reg, port);
137 outb(value, port + 1);
138 }
139
140 /*
141 * void pnp_unset_and_set_index(u16 port, u8 reg, u8 unset, u8 set)
142 * Description:
143 * This routine unsets and sets bits from indexed I/O registers. The
144 * reg byte is written to the index register at I/O address = port.
145 * The value byte to update is data register at I/O address = port + 1.
146 *
147 * Unlike and-then-or style operations, no bitwise negation is necessary
148 * to specify the bits to unset. Because the bitwise negation implicitly
149 * promotes operands to int before operating, one may have to explicitly
150 * downcast the result if the data width is smaller than that of an int.
151 * Since warnings are errors in coreboot, explicit casting is necessary.
152 *
153 * Performing said negation inside this routine alleviates this problem,
154 * while allowing the compiler to warn if the input parameters overflow.
155 * Casting outside this function would silence valid compiler warnings.
156 *
157 * Parameters:
158 * @param[in] u16 port = The address of the port index register.
159 * @param[in] u8 reg = The offset within the indexed space.
160 * @param[in] u8 unset = Bitmask with ones to the bits to unset from the data register.
161 * @param[in] u8 set = Bitmask with ones to the bits to set from the data register.
162 */
pnp_unset_and_set_index(u16 port,u8 reg,u8 unset,u8 set)163 static inline void pnp_unset_and_set_index(u16 port, u8 reg, u8 unset, u8 set)
164 {
165 outb(reg, port);
166
167 u8 value = inb(port + 1);
168 value &= (u8)~unset;
169 value |= set;
170 outb(value, port + 1);
171 }
172
173 #endif /* DEVICE_PNP_H */
174