Re: [PATCH v8 4/4] soc: ti: pruss: Add helper functions to set GPI mode, MII_RT_event and XFR

[Mathieu Poirier <mathieu.poirier@linaro.org>]

On Wed, Apr 12, 2023 at 04:00:12PM +0530, MD Danish Anwar wrote:
> From: Suman Anna <s-anna@ti.com>
> 
> The PRUSS CFG module is represented as a syscon node and is currently
> managed by the PRUSS platform driver. Add easy accessor functions to set
> GPI mode, MII_RT event enable/disable and XFR (XIN XOUT) enable/disable
> to enable the PRUSS Ethernet usecase. These functions reuse the generic
> pruss_cfg_update() API function.
> 
> Signed-off-by: Suman Anna <s-anna@ti.com>
> Co-developed-by: Grzegorz Jaszczyk <grzegorz.jaszczyk@linaro.org>
> Signed-off-by: Grzegorz Jaszczyk <grzegorz.jaszczyk@linaro.org>
> Signed-off-by: Puranjay Mohan <p-mohan@ti.com>
> Reviewed-by: Roger Quadros <rogerq@kernel.org>
> Reviewed-by: Tony Lindgren <tony@atomide.com>
> Reviewed-by: Simon Horman <simon.horman@corigine.com>
> Signed-off-by: MD Danish Anwar <danishanwar@ti.com>
> ---
>  drivers/remoteproc/pru_rproc.c | 15 -------
>  drivers/soc/ti/pruss.c         | 74 ++++++++++++++++++++++++++++++++++
>  include/linux/pruss_driver.h   | 51 +++++++++++++++++++++++
>  3 files changed, 125 insertions(+), 15 deletions(-)
> 
> diff --git a/drivers/remoteproc/pru_rproc.c b/drivers/remoteproc/pru_rproc.c
> index 095f66130f48..54f5ce302e7a 100644
> --- a/drivers/remoteproc/pru_rproc.c
> +++ b/drivers/remoteproc/pru_rproc.c
> @@ -81,21 +81,6 @@ enum pru_iomem {
>  	PRU_IOMEM_MAX,
>  };
>  
> -/**
> - * enum pru_type - PRU core type identifier
> - *
> - * @PRU_TYPE_PRU: Programmable Real-time Unit
> - * @PRU_TYPE_RTU: Auxiliary Programmable Real-Time Unit
> - * @PRU_TYPE_TX_PRU: Transmit Programmable Real-Time Unit
> - * @PRU_TYPE_MAX: just keep this one at the end
> - */
> -enum pru_type {
> -	PRU_TYPE_PRU = 0,
> -	PRU_TYPE_RTU,
> -	PRU_TYPE_TX_PRU,
> -	PRU_TYPE_MAX,
> -};
> -
>  /**
>   * struct pru_private_data - device data for a PRU core
>   * @type: type of the PRU core (PRU, RTU, Tx_PRU)
> diff --git a/drivers/soc/ti/pruss.c b/drivers/soc/ti/pruss.c
> index 34d513816a9d..90a625ab9cfc 100644
> --- a/drivers/soc/ti/pruss.c
> +++ b/drivers/soc/ti/pruss.c
> @@ -213,6 +213,80 @@ int pruss_cfg_set_gpmux(struct pruss *pruss, enum pruss_pru_id pru_id, u8 mux)
>  }
>  EXPORT_SYMBOL_GPL(pruss_cfg_set_gpmux);
>  
> +/**
> + * pruss_cfg_gpimode() - set the GPI mode of the PRU
> + * @pruss: the pruss instance handle
> + * @pru_id: id of the PRU core within the PRUSS
> + * @mode: GPI mode to set
> + *
> + * Sets the GPI mode for a given PRU by programming the
> + * corresponding PRUSS_CFG_GPCFGx register
> + *
> + * Return: 0 on success, or an error code otherwise
> + */
> +int pruss_cfg_gpimode(struct pruss *pruss, enum pruss_pru_id pru_id,
> +		      enum pruss_gpi_mode mode)
> +{
> +	if (pru_id < 0 || pru_id >= PRUSS_NUM_PRUS)
> +		return -EINVAL;
> +

Same

> +	if (mode < 0 || mode > PRUSS_GPI_MODE_MAX)
> +		return -EINVAL;
> +

Same

> +	return pruss_cfg_update(pruss, PRUSS_CFG_GPCFG(pru_id),
> +				PRUSS_GPCFG_PRU_GPI_MODE_MASK,
> +				mode << PRUSS_GPCFG_PRU_GPI_MODE_SHIFT);
> +}
> +EXPORT_SYMBOL_GPL(pruss_cfg_gpimode);
> +
> +/**
> + * pruss_cfg_miirt_enable() - Enable/disable MII RT Events
> + * @pruss: the pruss instance
> + * @enable: enable/disable
> + *
> + * Enable/disable the MII RT Events for the PRUSS.
> + *
> + * Return: 0 on success, or an error code otherwise
> + */
> +int pruss_cfg_miirt_enable(struct pruss *pruss, bool enable)
> +{
> +	u32 set = enable ? PRUSS_MII_RT_EVENT_EN : 0;
> +
> +	return pruss_cfg_update(pruss, PRUSS_CFG_MII_RT,
> +				PRUSS_MII_RT_EVENT_EN, set);
> +}
> +EXPORT_SYMBOL_GPL(pruss_cfg_miirt_enable);
> +
> +/**
> + * pruss_cfg_xfr_enable() - Enable/disable XIN XOUT shift functionality
> + * @pruss: the pruss instance
> + * @pru_type: PRU core type identifier
> + * @enable: enable/disable
> + *
> + * Return: 0 on success, or an error code otherwise
> + */
> +int pruss_cfg_xfr_enable(struct pruss *pruss, enum pru_type pru_type,
> +			 bool enable)
> +{
> +	u32 mask, set;
> +
> +	switch (pru_type) {
> +	case PRU_TYPE_PRU:
> +		mask = PRUSS_SPP_XFER_SHIFT_EN;
> +		break;
> +	case PRU_TYPE_RTU:
> +		mask = PRUSS_SPP_RTU_XFR_SHIFT_EN;
> +		break;
> +	default:
> +		return -EINVAL;
> +	}
> +
> +	set = enable ? mask : 0;
> +
> +	return pruss_cfg_update(pruss, PRUSS_CFG_SPP, mask, set);
> +}
> +EXPORT_SYMBOL_GPL(pruss_cfg_xfr_enable);
> +
>  static void pruss_of_free_clk_provider(void *data)
>  {
>  	struct device_node *clk_mux_np = data;
> diff --git a/include/linux/pruss_driver.h b/include/linux/pruss_driver.h
> index c70e08c90165..2a139bfda452 100644
> --- a/include/linux/pruss_driver.h
> +++ b/include/linux/pruss_driver.h
> @@ -32,6 +32,33 @@ enum pruss_gp_mux_sel {
>  	PRUSS_GP_MUX_SEL_MAX,
>  };
>  
> +/*
> + * enum pruss_gpi_mode - PRUSS GPI configuration modes, used
> + *			 to program the PRUSS_GPCFG0/1 registers
> + */
> +enum pruss_gpi_mode {
> +	PRUSS_GPI_MODE_DIRECT = 0,

Not needed

> +	PRUSS_GPI_MODE_PARALLEL,
> +	PRUSS_GPI_MODE_28BIT_SHIFT,
> +	PRUSS_GPI_MODE_MII,
> +	PRUSS_GPI_MODE_MAX,
> +};
> +
> +/**
> + * enum pru_type - PRU core type identifier
> + *
> + * @PRU_TYPE_PRU: Programmable Real-time Unit
> + * @PRU_TYPE_RTU: Auxiliary Programmable Real-Time Unit
> + * @PRU_TYPE_TX_PRU: Transmit Programmable Real-Time Unit
> + * @PRU_TYPE_MAX: just keep this one at the end
> + */
> +enum pru_type {
> +	PRU_TYPE_PRU = 0,

Same

With the above:
Reviewed-by: Mathieu Poirier <mathieu.poirier@linaro.org>

> +	PRU_TYPE_RTU,
> +	PRU_TYPE_TX_PRU,
> +	PRU_TYPE_MAX,
> +};
> +
>  /*
>   * enum pruss_mem - PRUSS memory range identifiers
>   */
> @@ -86,6 +113,11 @@ int pruss_release_mem_region(struct pruss *pruss,
>  			     struct pruss_mem_region *region);
>  int pruss_cfg_get_gpmux(struct pruss *pruss, enum pruss_pru_id pru_id, u8 *mux);
>  int pruss_cfg_set_gpmux(struct pruss *pruss, enum pruss_pru_id pru_id, u8 mux);
> +int pruss_cfg_gpimode(struct pruss *pruss, enum pruss_pru_id pru_id,
> +		      enum pruss_gpi_mode mode);
> +int pruss_cfg_miirt_enable(struct pruss *pruss, bool enable);
> +int pruss_cfg_xfr_enable(struct pruss *pruss, enum pru_type pru_type,
> +			 bool enable);
>  
>  #else
>  
> @@ -121,6 +153,25 @@ static inline int pruss_cfg_set_gpmux(struct pruss *pruss,
>  	return ERR_PTR(-EOPNOTSUPP);
>  }
>  
> +static inline int pruss_cfg_gpimode(struct pruss *pruss,
> +				    enum pruss_pru_id pru_id,
> +				    enum pruss_gpi_mode mode)
> +{
> +	return ERR_PTR(-EOPNOTSUPP);
> +}
> +
> +static inline int pruss_cfg_miirt_enable(struct pruss *pruss, bool enable)
> +{
> +	return ERR_PTR(-EOPNOTSUPP);
> +}
> +
> +static inline int pruss_cfg_xfr_enable(struct pruss *pruss,
> +				       enum pru_type pru_type,
> +				       bool enable);
> +{
> +	return ERR_PTR(-EOPNOTSUPP);
> +}
> +
>  #endif /* CONFIG_TI_PRUSS */
>  
>  #endif	/* _PRUSS_DRIVER_H_ */
> -- 
> 2.34.1
>