Re: [RFC PATCH 3/3] usb: typec: ucsi: Helpers for new GET_CONNECTOR_STATUS fields

[Heikki Krogerus <heikki.krogerus@linux.intel.com>]

On Wed, Aug 28, 2024 at 11:54:32PM +0000, Pilla, Siva sai kumar wrote:
> > 
> > UCSI v2 introduced new fields to GET_CONNECTOR_STATUS.
> > Adding a helper for each field. The helpers check that the
> > UCSI version is v2 or above.
> 
> I believe this approach helps us from ensuring new fields are only used in supported versions.
> 
> > 
> > Signed-off-by: Heikki Krogerus <heikki.krogerus@linux.intel.com>
> > ---
> >  drivers/usb/typec/ucsi/ucsi.h | 66 +++++++++++++++++++++++++++++++++++
> >  1 file changed, 66 insertions(+)
> > 
> > diff --git a/drivers/usb/typec/ucsi/ucsi.h b/drivers/usb/typec/ucsi/ucsi.h
> > index dfbc0f6c1b9b..adcbfc96dfcf 100644
> > --- a/drivers/usb/typec/ucsi/ucsi.h
> > +++ b/drivers/usb/typec/ucsi/ucsi.h
> > @@ -524,4 +524,70 @@ static inline void ucsi_debugfs_unregister(struct ucsi *ucsi) { }
> >  #define USB_TYPEC_NVIDIA_VLINK_DP_VDO	0x1
> >  #define USB_TYPEC_NVIDIA_VLINK_DBG_VDO	0x3
> > 
> > +/* -------------------------------------------------------------------------- */
> > +
> > +static inline enum typec_orientation ucsi_orientation(struct ucsi_connector *con)
> > +{
> > +	if (WARN_ON(con->ucsi->version < UCSI_VERSION_2_0))
> > +		return TYPEC_ORIENTATION_NONE;
> > +	return UCSI_FIELD(con->status, 86, 1) ? TYPEC_ORIENTATION_REVERSE :
> > +						TYPEC_ORIENTATION_NORMAL;
> > +}
> > +
> > +static inline int ucsi_sink_path_status(struct ucsi_connector *con)
> > +{
> > +	if (WARN_ON(con->ucsi->version < UCSI_VERSION_2_0))
> > +		return -EINVAL;
> > +	return UCSI_FIELD(con->status, 87, 1);
> > +}
> > +
> > +static inline int ucsi_reverse_current_protection_status(struct ucsi_connector *con)
> > +{
> > +	if (WARN_ON(con->ucsi->version < UCSI_VERSION_2_0))
> > +		return -EINVAL;
> > +	return UCSI_FIELD(con->status, 88, 1);
> > +}
> > +
> 
> I think the below fields are supported from UCSI v2.1 onwards. Can you please perform version check accordingly.

Good catch!

thanks,

> > +static inline int ucsi_power_reading_ready(struct ucsi_connector *con)
> > +{
> > +	if (WARN_ON(con->ucsi->version < UCSI_VERSION_2_0))
> > +		return -EINVAL;
> > +	return UCSI_FIELD(con->status, 89, 1);
> > +}
> > +
> > +static inline int ucsi_current_scale(struct ucsi_connector *con)
> > +{
> > +	if (WARN_ON(con->ucsi->version < UCSI_VERSION_2_0))
> > +		return -EINVAL;
> > +	return UCSI_FIELD(con->status, 90, 3) * 5; /* mA */
> > +}
> > +
> > +static inline int ucsi_peak_current(struct ucsi_connector *con)
> > +{
> > +	if (WARN_ON(con->ucsi->version < UCSI_VERSION_2_0))
> > +		return -EINVAL;
> > +	return UCSI_FIELD(con->status, 93, 16);
> > +}
> > +
> > +static inline int ucsi_average_current(struct ucsi_connector *con)
> > +{
> > +	if (WARN_ON(con->ucsi->version < UCSI_VERSION_2_0))
> > +		return -EINVAL;
> > +	return UCSI_FIELD(con->status, 109, 16);
> > +}
> > +
> > +static inline int ucsi_voltage_scale(struct ucsi_connector *con)
> > +{
> > +	if (WARN_ON(con->ucsi->version < UCSI_VERSION_2_0))
> > +		return -EINVAL;
> > +	return UCSI_FIELD(con->status, 125, 4) * 5; /* mV */
> > +}
> > +
> > +static inline int ucsi_voltage_reading(struct ucsi_connector *con)
> > +{
> > +	if (WARN_ON(con->ucsi->version < UCSI_VERSION_2_0))
> > +		return -EINVAL;
> > +	return UCSI_FIELD(con->status, 129, 16);
> > +}
> > +
> >  #endif /* __DRIVER_USB_TYPEC_UCSI_H */

-- 
heikki