1 // SPDX-License-Identifier: GPL-2.0-only 1 // SPDX-License-Identifier: GPL-2.0-only
2 /* 2 /*
3 // Copyright (c) 2022 Pengutronix, Oleksij Rem 3 // Copyright (c) 2022 Pengutronix, Oleksij Rempel <kernel@pengutronix.de>
4 */ 4 */
5 #ifndef _LINUX_PSE_CONTROLLER_H 5 #ifndef _LINUX_PSE_CONTROLLER_H
6 #define _LINUX_PSE_CONTROLLER_H 6 #define _LINUX_PSE_CONTROLLER_H
7 7
8 #include <linux/ethtool.h> 8 #include <linux/ethtool.h>
9 #include <linux/list.h> 9 #include <linux/list.h>
10 #include <uapi/linux/ethtool.h> 10 #include <uapi/linux/ethtool.h>
11 11
12 /* Maximum current in uA according to IEEE 802 <<
13 #define MAX_PI_CURRENT 1920000 <<
14 <<
15 struct phy_device; 12 struct phy_device;
16 struct pse_controller_dev; 13 struct pse_controller_dev;
17 14
18 /** 15 /**
19 * struct pse_control_config - PSE control/cha 16 * struct pse_control_config - PSE control/channel configuration.
20 * 17 *
21 * @podl_admin_control: set PoDL PSE admin con 18 * @podl_admin_control: set PoDL PSE admin control as described in
22 * IEEE 802.3-2018 30.15.1.2.1 acPoDLPSEA 19 * IEEE 802.3-2018 30.15.1.2.1 acPoDLPSEAdminControl
23 * @c33_admin_control: set PSE admin control a 20 * @c33_admin_control: set PSE admin control as described in
24 * IEEE 802.3-2022 30.9.1.2.1 acPSEAdminC 21 * IEEE 802.3-2022 30.9.1.2.1 acPSEAdminControl
25 */ 22 */
26 struct pse_control_config { 23 struct pse_control_config {
27 enum ethtool_podl_pse_admin_state podl 24 enum ethtool_podl_pse_admin_state podl_admin_control;
28 enum ethtool_c33_pse_admin_state c33_a 25 enum ethtool_c33_pse_admin_state c33_admin_control;
29 }; 26 };
30 27
31 /** 28 /**
32 * struct pse_control_status - PSE control/cha 29 * struct pse_control_status - PSE control/channel status.
33 * 30 *
34 * @podl_admin_state: operational state of the 31 * @podl_admin_state: operational state of the PoDL PSE
35 * functions. IEEE 802.3-2018 30.15.1.1.2 32 * functions. IEEE 802.3-2018 30.15.1.1.2 aPoDLPSEAdminState
36 * @podl_pw_status: power detection status of 33 * @podl_pw_status: power detection status of the PoDL PSE.
37 * IEEE 802.3-2018 30.15.1.1.3 aPoDLPSEPo 34 * IEEE 802.3-2018 30.15.1.1.3 aPoDLPSEPowerDetectionStatus:
38 * @c33_admin_state: operational state of the 35 * @c33_admin_state: operational state of the PSE
39 * functions. IEEE 802.3-2022 30.9.1.1.2 36 * functions. IEEE 802.3-2022 30.9.1.1.2 aPSEAdminState
40 * @c33_pw_status: power detection status of t 37 * @c33_pw_status: power detection status of the PSE.
41 * IEEE 802.3-2022 30.9.1.1.5 aPSEPowerDe 38 * IEEE 802.3-2022 30.9.1.1.5 aPSEPowerDetectionStatus:
42 * @c33_pw_class: detected class of a powered <<
43 * IEEE 802.3-2022 30.9.1.1.8 aPSEPowerCl <<
44 * @c33_actual_pw: power currently delivered b <<
45 * IEEE 802.3-2022 30.9.1.1.23 aPSEActual <<
46 * @c33_ext_state_info: extended state informa <<
47 * @c33_avail_pw_limit: available power limit <<
48 * IEEE 802.3-2022 145.2.5.4 pse_avail_pw <<
49 * @c33_pw_limit_ranges: supported power limit <<
50 * is in charge of the memory allocation. <<
51 * @c33_pw_limit_nb_ranges: number of supporte <<
52 * ranges <<
53 */ 39 */
54 struct pse_control_status { 40 struct pse_control_status {
55 enum ethtool_podl_pse_admin_state podl 41 enum ethtool_podl_pse_admin_state podl_admin_state;
56 enum ethtool_podl_pse_pw_d_status podl 42 enum ethtool_podl_pse_pw_d_status podl_pw_status;
57 enum ethtool_c33_pse_admin_state c33_a 43 enum ethtool_c33_pse_admin_state c33_admin_state;
58 enum ethtool_c33_pse_pw_d_status c33_p 44 enum ethtool_c33_pse_pw_d_status c33_pw_status;
59 u32 c33_pw_class; <<
60 u32 c33_actual_pw; <<
61 struct ethtool_c33_pse_ext_state_info <<
62 u32 c33_avail_pw_limit; <<
63 struct ethtool_c33_pse_pw_limit_range <<
64 u32 c33_pw_limit_nb_ranges; <<
65 }; 45 };
66 46
67 /** 47 /**
68 * struct pse_controller_ops - PSE controller 48 * struct pse_controller_ops - PSE controller driver callbacks
69 * 49 *
70 * @ethtool_get_status: get PSE control status 50 * @ethtool_get_status: get PSE control status for ethtool interface
71 * @setup_pi_matrix: setup PI matrix of the PS 51 * @setup_pi_matrix: setup PI matrix of the PSE controller
72 * @pi_is_enabled: Return 1 if the PSE PI is e 52 * @pi_is_enabled: Return 1 if the PSE PI is enabled, 0 if not.
73 * May also return negative er 53 * May also return negative errno.
74 * @pi_enable: Configure the PSE PI as enabled 54 * @pi_enable: Configure the PSE PI as enabled.
75 * @pi_disable: Configure the PSE PI as disabl 55 * @pi_disable: Configure the PSE PI as disabled.
76 * @pi_get_voltage: Return voltage similarly t <<
77 * callback. <<
78 * @pi_get_current_limit: Get the configured c <<
79 * get_current_limit re <<
80 * @pi_set_current_limit: Configure the curren <<
81 * set_current_limit re <<
82 * Should not return an <<
83 * current value set. <<
84 */ 56 */
85 struct pse_controller_ops { 57 struct pse_controller_ops {
86 int (*ethtool_get_status)(struct pse_c 58 int (*ethtool_get_status)(struct pse_controller_dev *pcdev,
87 unsigned long id, struct netli 59 unsigned long id, struct netlink_ext_ack *extack,
88 struct pse_control_status *sta 60 struct pse_control_status *status);
89 int (*setup_pi_matrix)(struct pse_cont 61 int (*setup_pi_matrix)(struct pse_controller_dev *pcdev);
90 int (*pi_is_enabled)(struct pse_contro 62 int (*pi_is_enabled)(struct pse_controller_dev *pcdev, int id);
91 int (*pi_enable)(struct pse_controller 63 int (*pi_enable)(struct pse_controller_dev *pcdev, int id);
92 int (*pi_disable)(struct pse_controlle 64 int (*pi_disable)(struct pse_controller_dev *pcdev, int id);
93 int (*pi_get_voltage)(struct pse_contr <<
94 int (*pi_get_current_limit)(struct pse <<
95 int id); <<
96 int (*pi_set_current_limit)(struct pse <<
97 int id, in <<
98 }; 65 };
99 66
100 struct module; 67 struct module;
101 struct device_node; 68 struct device_node;
102 struct of_phandle_args; 69 struct of_phandle_args;
103 struct pse_control; 70 struct pse_control;
104 71
105 /* PSE PI pairset pinout can either be Alterna 72 /* PSE PI pairset pinout can either be Alternative A or Alternative B */
106 enum pse_pi_pairset_pinout { 73 enum pse_pi_pairset_pinout {
107 ALTERNATIVE_A, 74 ALTERNATIVE_A,
108 ALTERNATIVE_B, 75 ALTERNATIVE_B,
109 }; 76 };
110 77
111 /** 78 /**
112 * struct pse_pi_pairset - PSE PI pairset enti 79 * struct pse_pi_pairset - PSE PI pairset entity describing the pinout
113 * alternative ant its 80 * alternative ant its phandle
114 * 81 *
115 * @pinout: description of the pinout alternat 82 * @pinout: description of the pinout alternative
116 * @np: device node pointer describing the pai 83 * @np: device node pointer describing the pairset phandle
117 */ 84 */
118 struct pse_pi_pairset { 85 struct pse_pi_pairset {
119 enum pse_pi_pairset_pinout pinout; 86 enum pse_pi_pairset_pinout pinout;
120 struct device_node *np; 87 struct device_node *np;
121 }; 88 };
122 89
123 /** 90 /**
124 * struct pse_pi - PSE PI (Power Interface) en 91 * struct pse_pi - PSE PI (Power Interface) entity as described in
125 * IEEE 802.3-2022 145.2.4 92 * IEEE 802.3-2022 145.2.4
126 * 93 *
127 * @pairset: table of the PSE PI pinout altern 94 * @pairset: table of the PSE PI pinout alternative for the two pairset
128 * @np: device node pointer of the PSE PI node 95 * @np: device node pointer of the PSE PI node
129 * @rdev: regulator represented by the PSE PI 96 * @rdev: regulator represented by the PSE PI
130 * @admin_state_enabled: PI enabled state 97 * @admin_state_enabled: PI enabled state
131 */ 98 */
132 struct pse_pi { 99 struct pse_pi {
133 struct pse_pi_pairset pairset[2]; 100 struct pse_pi_pairset pairset[2];
134 struct device_node *np; 101 struct device_node *np;
135 struct regulator_dev *rdev; 102 struct regulator_dev *rdev;
136 bool admin_state_enabled; 103 bool admin_state_enabled;
137 }; 104 };
138 105
139 /** 106 /**
140 * struct pse_controller_dev - PSE controller 107 * struct pse_controller_dev - PSE controller entity that might
141 * provide multipl 108 * provide multiple PSE controls
142 * @ops: a pointer to device specific struct p 109 * @ops: a pointer to device specific struct pse_controller_ops
143 * @owner: kernel module of the PSE controller 110 * @owner: kernel module of the PSE controller driver
144 * @list: internal list of PSE controller devi 111 * @list: internal list of PSE controller devices
145 * @pse_control_head: head of internal list of 112 * @pse_control_head: head of internal list of requested PSE controls
146 * @dev: corresponding driver model device str 113 * @dev: corresponding driver model device struct
147 * @of_pse_n_cells: number of cells in PSE lin 114 * @of_pse_n_cells: number of cells in PSE line specifiers
148 * @nr_lines: number of PSE controls in this c 115 * @nr_lines: number of PSE controls in this controller device
149 * @lock: Mutex for serialization access to th 116 * @lock: Mutex for serialization access to the PSE controller
150 * @types: types of the PSE controller 117 * @types: types of the PSE controller
151 * @pi: table of PSE PIs described in this con 118 * @pi: table of PSE PIs described in this controller device
152 * @no_of_pse_pi: flag set if the pse_pis devi 119 * @no_of_pse_pi: flag set if the pse_pis devicetree node is not used
153 */ 120 */
154 struct pse_controller_dev { 121 struct pse_controller_dev {
155 const struct pse_controller_ops *ops; 122 const struct pse_controller_ops *ops;
156 struct module *owner; 123 struct module *owner;
157 struct list_head list; 124 struct list_head list;
158 struct list_head pse_control_head; 125 struct list_head pse_control_head;
159 struct device *dev; 126 struct device *dev;
160 int of_pse_n_cells; 127 int of_pse_n_cells;
161 unsigned int nr_lines; 128 unsigned int nr_lines;
162 struct mutex lock; 129 struct mutex lock;
163 enum ethtool_pse_types types; 130 enum ethtool_pse_types types;
164 struct pse_pi *pi; 131 struct pse_pi *pi;
165 bool no_of_pse_pi; 132 bool no_of_pse_pi;
166 }; 133 };
167 134
168 #if IS_ENABLED(CONFIG_PSE_CONTROLLER) 135 #if IS_ENABLED(CONFIG_PSE_CONTROLLER)
169 int pse_controller_register(struct pse_control 136 int pse_controller_register(struct pse_controller_dev *pcdev);
170 void pse_controller_unregister(struct pse_cont 137 void pse_controller_unregister(struct pse_controller_dev *pcdev);
171 struct device; 138 struct device;
172 int devm_pse_controller_register(struct device 139 int devm_pse_controller_register(struct device *dev,
173 struct pse_co 140 struct pse_controller_dev *pcdev);
174 141
175 struct pse_control *of_pse_control_get(struct 142 struct pse_control *of_pse_control_get(struct device_node *node);
176 void pse_control_put(struct pse_control *psec) 143 void pse_control_put(struct pse_control *psec);
177 144
178 int pse_ethtool_get_status(struct pse_control 145 int pse_ethtool_get_status(struct pse_control *psec,
179 struct netlink_ext_ 146 struct netlink_ext_ack *extack,
180 struct pse_control_ 147 struct pse_control_status *status);
181 int pse_ethtool_set_config(struct pse_control 148 int pse_ethtool_set_config(struct pse_control *psec,
182 struct netlink_ext_ 149 struct netlink_ext_ack *extack,
183 const struct pse_co 150 const struct pse_control_config *config);
184 int pse_ethtool_set_pw_limit(struct pse_contro <<
185 struct netlink_ex <<
186 const unsigned in <<
187 int pse_ethtool_get_pw_limit(struct pse_contro <<
188 struct netlink_ex <<
189 151
190 bool pse_has_podl(struct pse_control *psec); 152 bool pse_has_podl(struct pse_control *psec);
191 bool pse_has_c33(struct pse_control *psec); 153 bool pse_has_c33(struct pse_control *psec);
192 154
193 #else 155 #else
194 156
195 static inline struct pse_control *of_pse_contr 157 static inline struct pse_control *of_pse_control_get(struct device_node *node)
196 { 158 {
197 return ERR_PTR(-ENOENT); 159 return ERR_PTR(-ENOENT);
198 } 160 }
199 161
200 static inline void pse_control_put(struct pse_ 162 static inline void pse_control_put(struct pse_control *psec)
201 { 163 {
202 } 164 }
203 165
204 static inline int pse_ethtool_get_status(struc 166 static inline int pse_ethtool_get_status(struct pse_control *psec,
205 struc 167 struct netlink_ext_ack *extack,
206 struc 168 struct pse_control_status *status)
207 { 169 {
208 return -EOPNOTSUPP; 170 return -EOPNOTSUPP;
209 } 171 }
210 172
211 static inline int pse_ethtool_set_config(struc 173 static inline int pse_ethtool_set_config(struct pse_control *psec,
212 struc 174 struct netlink_ext_ack *extack,
213 const 175 const struct pse_control_config *config)
214 { <<
215 return -EOPNOTSUPP; <<
216 } <<
217 <<
218 static inline int pse_ethtool_set_pw_limit(str <<
219 str <<
220 con <<
221 { <<
222 return -EOPNOTSUPP; <<
223 } <<
224 <<
225 static inline int pse_ethtool_get_pw_limit(str <<
226 str <<
227 { 176 {
228 return -EOPNOTSUPP; 177 return -EOPNOTSUPP;
229 } 178 }
230 179
231 static inline bool pse_has_podl(struct pse_con 180 static inline bool pse_has_podl(struct pse_control *psec)
232 { 181 {
233 return false; 182 return false;
234 } 183 }
235 184
236 static inline bool pse_has_c33(struct pse_cont 185 static inline bool pse_has_c33(struct pse_control *psec)
237 { 186 {
238 return false; 187 return false;
239 } 188 }
240 189
241 #endif 190 #endif
242 191
243 #endif 192 #endif
244 193
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.