include/linux/pse-pd/pse.h

// SPDX-License-Identifier: GPL-2.0-only
/*
// Copyright (c) 2022 Pengutronix, Oleksij Rempel <kernel@pengutronix.de>
 */
#ifndef _LINUX_PSE_CONTROLLER_H
#define _LINUX_PSE_CONTROLLER_H

#include <linux/list.h>
#include <linux/netlink.h>
#include <linux/kfifo.h>
#include <uapi/linux/ethtool.h>
#include <uapi/linux/ethtool_netlink_generated.h>
#include <linux/regulator/driver.h>

/* Maximum current in uA according to IEEE 802.3-2022 Table 145-1 */
#define MAX_PI_CURRENT 1920000
/* Maximum power in mW according to IEEE 802.3-2022 Table 145-16 */
#define MAX_PI_PW 99900

struct net_device;
struct phy_device;
struct pse_controller_dev;
struct netlink_ext_ack;

/* C33 PSE extended state and substate. */
struct ethtool_c33_pse_ext_state_info {
	enum ethtool_c33_pse_ext_state c33_pse_ext_state;
	union {
		enum ethtool_c33_pse_ext_substate_error_condition error_condition;
		enum ethtool_c33_pse_ext_substate_mr_pse_enable mr_pse_enable;
		enum ethtool_c33_pse_ext_substate_option_detect_ted option_detect_ted;
		enum ethtool_c33_pse_ext_substate_option_vport_lim option_vport_lim;
		enum ethtool_c33_pse_ext_substate_ovld_detected ovld_detected;
		enum ethtool_c33_pse_ext_substate_power_not_available power_not_available;
		enum ethtool_c33_pse_ext_substate_short_detected short_detected;
		u32 __c33_pse_ext_substate;
	};
};

struct ethtool_c33_pse_pw_limit_range {
	u32 min;
	u32 max;
};

/**
 * struct pse_irq_desc - notification sender description for IRQ based events.
 *
 * @name: the visible name for the IRQ
 * @map_event: driver callback to map IRQ status into PSE devices with events.
 */
struct pse_irq_desc {
	const char *name;
	int (*map_event)(int irq, struct pse_controller_dev *pcdev,
			 unsigned long *notifs,
			 unsigned long *notifs_mask);
};

/**
 * struct pse_control_config - PSE control/channel configuration.
 *
 * @podl_admin_control: set PoDL PSE admin control as described in
 *	IEEE 802.3-2018 30.15.1.2.1 acPoDLPSEAdminControl
 * @c33_admin_control: set PSE admin control as described in
 *	IEEE 802.3-2022 30.9.1.2.1 acPSEAdminControl
 */
struct pse_control_config {
	enum ethtool_podl_pse_admin_state podl_admin_control;
	enum ethtool_c33_pse_admin_state c33_admin_control;
};

/**
 * struct pse_admin_state - PSE operational state
 *
 * @podl_admin_state: operational state of the PoDL PSE
 *	functions. IEEE 802.3-2018 30.15.1.1.2 aPoDLPSEAdminState
 * @c33_admin_state: operational state of the PSE
 *	functions. IEEE 802.3-2022 30.9.1.1.2 aPSEAdminState
 */
struct pse_admin_state {
	enum ethtool_podl_pse_admin_state podl_admin_state;
	enum ethtool_c33_pse_admin_state c33_admin_state;
};

/**
 * struct pse_pw_status - PSE power detection status
 *
 * @podl_pw_status: power detection status of the PoDL PSE.
 *	IEEE 802.3-2018 30.15.1.1.3 aPoDLPSEPowerDetectionStatus:
 * @c33_pw_status: power detection status of the PSE.
 *	IEEE 802.3-2022 30.9.1.1.5 aPSEPowerDetectionStatus:
 */
struct pse_pw_status {
	enum ethtool_podl_pse_pw_d_status podl_pw_status;
	enum ethtool_c33_pse_pw_d_status c33_pw_status;
};

/**
 * struct pse_ext_state_info - PSE extended state information
 *
 * @c33_ext_state_info: extended state information of the PSE
 */
struct pse_ext_state_info {
	struct ethtool_c33_pse_ext_state_info c33_ext_state_info;
};

/**
 * struct pse_pw_limit_ranges - PSE power limit configuration range
 *
 * @c33_pw_limit_ranges: supported power limit configuration range. The driver
 *			 is in charge of the memory allocation.
 */
struct pse_pw_limit_ranges {
	struct ethtool_c33_pse_pw_limit_range *c33_pw_limit_ranges;
};

/**
 * struct ethtool_pse_control_status - PSE control/channel status.
 *
 * @pw_d_id: PSE power domain index.
 * @podl_admin_state: operational state of the PoDL PSE
 *	functions. IEEE 802.3-2018 30.15.1.1.2 aPoDLPSEAdminState
 * @podl_pw_status: power detection status of the PoDL PSE.
 *	IEEE 802.3-2018 30.15.1.1.3 aPoDLPSEPowerDetectionStatus:
 * @c33_admin_state: operational state of the PSE
 *	functions. IEEE 802.3-2022 30.9.1.1.2 aPSEAdminState
 * @c33_pw_status: power detection status of the PSE.
 *	IEEE 802.3-2022 30.9.1.1.5 aPSEPowerDetectionStatus:
 * @c33_pw_class: detected class of a powered PD
 *	IEEE 802.3-2022 30.9.1.1.8 aPSEPowerClassification
 * @c33_actual_pw: power currently delivered by the PSE in mW
 *	IEEE 802.3-2022 30.9.1.1.23 aPSEActualPower
 * @c33_ext_state_info: extended state information of the PSE
 * @c33_avail_pw_limit: available power limit of the PSE in mW
 *	IEEE 802.3-2022 145.2.5.4 pse_avail_pwr
 * @c33_pw_limit_ranges: supported power limit configuration range. The driver
 *	is in charge of the memory allocation
 * @c33_pw_limit_nb_ranges: number of supported power limit configuration
 *	ranges
 * @prio_max: max priority allowed for the c33_prio variable value.
 * @prio: priority of the PSE. Managed by PSE core in case of static budget
 *	evaluation strategy.
 */
struct ethtool_pse_control_status {
	u32 pw_d_id;
	enum ethtool_podl_pse_admin_state podl_admin_state;
	enum ethtool_podl_pse_pw_d_status podl_pw_status;
	enum ethtool_c33_pse_admin_state c33_admin_state;
	enum ethtool_c33_pse_pw_d_status c33_pw_status;
	u32 c33_pw_class;
	u32 c33_actual_pw;
	struct ethtool_c33_pse_ext_state_info c33_ext_state_info;
	u32 c33_avail_pw_limit;
	struct ethtool_c33_pse_pw_limit_range *c33_pw_limit_ranges;
	u32 c33_pw_limit_nb_ranges;
	u32 prio_max;
	u32 prio;
};

/**
 * struct pse_controller_ops - PSE controller driver callbacks
 *
 * @setup_pi_matrix: Setup PI matrix of the PSE controller.
 *		     The PSE PIs devicetree nodes have already been parsed by
 *		     of_load_pse_pis() and the pcdev->pi[x]->pairset[y].np
 *		     populated. This callback should establish the
 *		     relationship between the PSE controller hardware ports
 *		     and the PSE Power Interfaces, either through software
 *		     mapping or hardware configuration.
 * @pi_get_admin_state: Get the operational state of the PSE PI. This ops
 *			is mandatory.
 * @pi_get_pw_status: Get the power detection status of the PSE PI. This
 *		      ops is mandatory.
 * @pi_get_ext_state: Get the extended state of the PSE PI.
 * @pi_get_pw_class: Get the power class of the PSE PI.
 * @pi_get_actual_pw: Get actual power of the PSE PI in mW.
 * @pi_enable: Configure the PSE PI as enabled.
 * @pi_disable: Configure the PSE PI as disabled.
 * @pi_get_voltage: Return voltage similarly to get_voltage regulator
 *		    callback in uV.
 * @pi_get_pw_limit: Get the configured power limit of the PSE PI in mW.
 * @pi_set_pw_limit: Configure the power limit of the PSE PI in mW.
 * @pi_get_pw_limit_ranges: Get the supported power limit configuration
 *			    range. The driver is in charge of the memory
 *			    allocation and should return the number of
 *			    ranges.
 * @pi_get_prio: Get the PSE PI priority.
 * @pi_set_prio: Configure the PSE PI priority.
 * @pi_get_pw_req: Get the power requested by a PD before enabling the PSE PI.
 *		   This is only relevant when an interrupt is registered using
 *		   devm_pse_irq_helper helper.
 */
struct pse_controller_ops {
	int (*setup_pi_matrix)(struct pse_controller_dev *pcdev);
	int (*pi_get_admin_state)(struct pse_controller_dev *pcdev, int id,
				  struct pse_admin_state *admin_state);
	int (*pi_get_pw_status)(struct pse_controller_dev *pcdev, int id,
				struct pse_pw_status *pw_status);
	int (*pi_get_ext_state)(struct pse_controller_dev *pcdev, int id,
				struct pse_ext_state_info *ext_state_info);
	int (*pi_get_pw_class)(struct pse_controller_dev *pcdev, int id);
	int (*pi_get_actual_pw)(struct pse_controller_dev *pcdev, int id);
	int (*pi_enable)(struct pse_controller_dev *pcdev, int id);
	int (*pi_disable)(struct pse_controller_dev *pcdev, int id);
	int (*pi_get_voltage)(struct pse_controller_dev *pcdev, int id);
	int (*pi_get_pw_limit)(struct pse_controller_dev *pcdev,
			       int id);
	int (*pi_set_pw_limit)(struct pse_controller_dev *pcdev,
			       int id, int max_mW);
	int (*pi_get_pw_limit_ranges)(struct pse_controller_dev *pcdev, int id,
				      struct pse_pw_limit_ranges *pw_limit_ranges);
	int (*pi_get_prio)(struct pse_controller_dev *pcdev, int id);
	int (*pi_set_prio)(struct pse_controller_dev *pcdev, int id,
			   unsigned int prio);
	int (*pi_get_pw_req)(struct pse_controller_dev *pcdev, int id);
};

struct module;
struct device_node;
struct of_phandle_args;
struct pse_control;
struct ethtool_pse_control_status;

/* PSE PI pairset pinout can either be Alternative A or Alternative B */
enum pse_pi_pairset_pinout {
	ALTERNATIVE_A,
	ALTERNATIVE_B,
};

/**
 * struct pse_pi_pairset - PSE PI pairset entity describing the pinout
 *			   alternative ant its phandle
 *
 * @pinout: description of the pinout alternative
 * @np: device node pointer describing the pairset phandle
 */
struct pse_pi_pairset {
	enum pse_pi_pairset_pinout pinout;
	struct device_node *np;
};

/**
 * struct pse_pi - PSE PI (Power Interface) entity as described in
 *		   IEEE 802.3-2022 145.2.4
 *
 * @pairset: table of the PSE PI pinout alternative for the two pairset
 * @np: device node pointer of the PSE PI node
 * @rdev: regulator represented by the PSE PI
 * @admin_state_enabled: PI enabled state
 * @pw_d: Power domain of the PSE PI
 * @prio: Priority of the PSE PI. Used in static budget evaluation strategy
 * @isr_pd_detected: PSE PI detection status managed by the interruption
 *		     handler. This variable is relevant when the power enabled
 *		     management is managed in software like the static
 *		     budget evaluation strategy.
 * @pw_allocated_mW: Power allocated to a PSE PI to manage power budget in
 *		     static budget evaluation strategy.
 */
struct pse_pi {
	struct pse_pi_pairset pairset[2];
	struct device_node *np;
	struct regulator_dev *rdev;
	bool admin_state_enabled;
	struct pse_power_domain *pw_d;
	int prio;
	bool isr_pd_detected;
	int pw_allocated_mW;
};

/**
 * struct pse_ntf - PSE notification element
 *
 * @id: ID of the PSE control
 * @notifs: PSE notifications to be reported
 */
struct pse_ntf {
	int id;
	unsigned long notifs;
};

/**
 * struct pse_controller_dev - PSE controller entity that might
 *                             provide multiple PSE controls
 * @ops: a pointer to device specific struct pse_controller_ops
 * @owner: kernel module of the PSE controller driver
 * @list: internal list of PSE controller devices
 * @pse_control_head: head of internal list of requested PSE controls
 * @dev: corresponding driver model device struct
 * @of_pse_n_cells: number of cells in PSE line specifiers
 * @nr_lines: number of PSE controls in this controller device
 * @lock: Mutex for serialization access to the PSE controller
 * @types: types of the PSE controller
 * @pi: table of PSE PIs described in this controller device
 * @no_of_pse_pi: flag set if the pse_pis devicetree node is not used
 * @irq: PSE interrupt
 * @pis_prio_max: Maximum value allowed for the PSE PIs priority
 * @supp_budget_eval_strategies: budget evaluation strategies supported
 *				 by the PSE
 * @ntf_work: workqueue for PSE notification management
 * @ntf_fifo: PSE notifications FIFO
 * @ntf_fifo_lock: protect @ntf_fifo writer
 */
struct pse_controller_dev {
	const struct pse_controller_ops *ops;
	struct module *owner;
	struct list_head list;
	struct list_head pse_control_head;
	struct device *dev;
	int of_pse_n_cells;
	unsigned int nr_lines;
	struct mutex lock;
	enum ethtool_pse_types types;
	struct pse_pi *pi;
	bool no_of_pse_pi;
	int irq;
	unsigned int pis_prio_max;
	u32 supp_budget_eval_strategies;
	struct work_struct ntf_work;
	DECLARE_KFIFO_PTR(ntf_fifo, struct pse_ntf);
	spinlock_t ntf_fifo_lock; /* Protect @ntf_fifo writer */
};

/**
 * enum pse_budget_eval_strategies - PSE budget evaluation strategies.
 * @PSE_BUDGET_EVAL_STRAT_DISABLED: Budget evaluation strategy disabled.
 * @PSE_BUDGET_EVAL_STRAT_STATIC: PSE static budget evaluation strategy.
 *	Budget evaluation strategy based on the power requested during PD
 *	classification. This strategy is managed by the PSE core.
 * @PSE_BUDGET_EVAL_STRAT_DYNAMIC: PSE dynamic budget evaluation
 *	strategy. Budget evaluation strategy based on the current consumption
 *	per ports compared to the total	power budget. This mode is managed by
 *	the PSE controller.
 */

enum pse_budget_eval_strategies {
	PSE_BUDGET_EVAL_STRAT_DISABLED	= 1 << 0,
	PSE_BUDGET_EVAL_STRAT_STATIC	= 1 << 1,
	PSE_BUDGET_EVAL_STRAT_DYNAMIC	= 1 << 2,
};

#if IS_ENABLED(CONFIG_PSE_CONTROLLER)
int pse_controller_register(struct pse_controller_dev *pcdev);
void pse_controller_unregister(struct pse_controller_dev *pcdev);
struct device;
int devm_pse_controller_register(struct device *dev,
				 struct pse_controller_dev *pcdev);
int devm_pse_irq_helper(struct pse_controller_dev *pcdev, int irq,
			int irq_flags, const struct pse_irq_desc *d);

struct pse_control *of_pse_control_get(struct device_node *node,
				       struct phy_device *phydev);
void pse_control_put(struct pse_control *psec);

int pse_ethtool_get_status(struct pse_control *psec,
			   struct netlink_ext_ack *extack,
			   struct ethtool_pse_control_status *status);
int pse_ethtool_set_config(struct pse_control *psec,
			   struct netlink_ext_ack *extack,
			   const struct pse_control_config *config);
int pse_ethtool_set_pw_limit(struct pse_control *psec,
			     struct netlink_ext_ack *extack,
			     const unsigned int pw_limit);
int pse_ethtool_set_prio(struct pse_control *psec,
			 struct netlink_ext_ack *extack,
			 unsigned int prio);

bool pse_has_podl(struct pse_control *psec);
bool pse_has_c33(struct pse_control *psec);

#else

static inline struct pse_control *of_pse_control_get(struct device_node *node,
						     struct phy_device *phydev)
{
	return ERR_PTR(-ENOENT);
}

static inline void pse_control_put(struct pse_control *psec)
{
}

static inline int pse_ethtool_get_status(struct pse_control *psec,
					 struct netlink_ext_ack *extack,
					 struct ethtool_pse_control_status *status)
{
	return -EOPNOTSUPP;
}

static inline int pse_ethtool_set_config(struct pse_control *psec,
					 struct netlink_ext_ack *extack,
					 const struct pse_control_config *config)
{
	return -EOPNOTSUPP;
}

static inline int pse_ethtool_set_pw_limit(struct pse_control *psec,
					   struct netlink_ext_ack *extack,
					   const unsigned int pw_limit)
{
	return -EOPNOTSUPP;
}

static inline int pse_ethtool_set_prio(struct pse_control *psec,
				       struct netlink_ext_ack *extack,
				       unsigned int prio)
{
	return -EOPNOTSUPP;
}

static inline bool pse_has_podl(struct pse_control *psec)
{
	return false;
}

static inline bool pse_has_c33(struct pse_control *psec)
{
	return false;
}

#endif

#endif