diff mbox series

[net,v2,1/2] ptp: ocp: adjust sysfs entries to expose tty information

Message ID 20240805220500.1808797-1-vadfed@meta.com (mailing list archive)
State Superseded
Delegated to: Netdev Maintainers
Headers show
Series [net,v2,1/2] ptp: ocp: adjust sysfs entries to expose tty information | expand

Checks

Context Check Description
netdev/series_format success Single patches do not need cover letters
netdev/tree_selection success Clearly marked for net
netdev/ynl success Generated files up to date; no warnings/errors; no diff in generated;
netdev/fixes_present success Fixes tag present in non-next series
netdev/header_inline success No static functions without inline keyword in header files
netdev/build_32bit success Errors and warnings before: 29 this patch: 29
netdev/build_tools success No tools touched, skip
netdev/cc_maintainers fail 1 blamed authors not CCed: tony@atomide.com; 3 maintainers not CCed: vadfed@linux.dev richardcochran@gmail.com tony@atomide.com
netdev/build_clang success Errors and warnings before: 29 this patch: 29
netdev/verify_signedoff success Signed-off-by tag matches author and committer
netdev/deprecated_api success None detected
netdev/check_selftest success No net selftest shell script
netdev/verify_fixes success Fixes tag looks correct
netdev/build_allmodconfig_warn success Errors and warnings before: 29 this patch: 29
netdev/checkpatch warning CHECK: Please use a blank line after function/struct/union/enum declarations WARNING: line length of 82 exceeds 80 columns WARNING: line length of 84 exceeds 80 columns WARNING: return sysfs_emit(...) formats should include a terminating newline
netdev/build_clang_rust success No Rust files in patch. Skipping build
netdev/kdoc success Errors and warnings before: 0 this patch: 0
netdev/source_inline success Was 0 now: 0
netdev/contest success net-next-2024-08-06--00-00 (tests: 707)

Commit Message

Vadim Fedorenko Aug. 5, 2024, 10:04 p.m. UTC
Starting v6.8 the serial port subsystem changed the hierarchy of devices
and symlinks are not working anymore. Previous discussion made it clear
that the idea of symlinks for tty devices was wrong by design. Implement
additional attributes to expose the information. Fixes tag points to the
commit which introduced the change.

Fixes: b286f4e87e32 ("serial: core: Move tty and serdev to be children of serial core port device")
Signed-off-by: Vadim Fedorenko <vadfed@meta.com>
---
 drivers/ptp/ptp_ocp.c | 68 +++++++++++++++++++++++++++++++++----------
 1 file changed, 52 insertions(+), 16 deletions(-)

Comments

Greg Kroah-Hartman Aug. 13, 2024, 9:33 a.m. UTC | #1
On Mon, Aug 05, 2024 at 03:04:59PM -0700, Vadim Fedorenko wrote:
> Starting v6.8 the serial port subsystem changed the hierarchy of devices
> and symlinks are not working anymore. Previous discussion made it clear
> that the idea of symlinks for tty devices was wrong by design. Implement
> additional attributes to expose the information. Fixes tag points to the
> commit which introduced the change.
> 
> Fixes: b286f4e87e32 ("serial: core: Move tty and serdev to be children of serial core port device")
> Signed-off-by: Vadim Fedorenko <vadfed@meta.com>
> ---
>  drivers/ptp/ptp_ocp.c | 68 +++++++++++++++++++++++++++++++++----------
>  1 file changed, 52 insertions(+), 16 deletions(-)
> 
> diff --git a/drivers/ptp/ptp_ocp.c b/drivers/ptp/ptp_ocp.c
> index ee2ced88ab34..7a5026656452 100644
> --- a/drivers/ptp/ptp_ocp.c
> +++ b/drivers/ptp/ptp_ocp.c
> @@ -3346,6 +3346,55 @@ static EXT_ATTR_RO(freq, frequency, 1);
>  static EXT_ATTR_RO(freq, frequency, 2);
>  static EXT_ATTR_RO(freq, frequency, 3);
>  
> +static ssize_t
> +ptp_ocp_tty_show(struct device *dev, struct device_attribute *attr, char *buf)
> +{
> +	struct dev_ext_attribute *ea = to_ext_attr(attr);
> +	struct ptp_ocp *bp = dev_get_drvdata(dev);
> +	struct ptp_ocp_serial_port *port;
> +
> +	port = (void *)((uintptr_t)bp + (uintptr_t)ea->var);

That's insane pointer math, how do we know this is correct?

> +	return sysfs_emit(buf, "ttyS%d", port->line);
> +}
> +
> +static umode_t
> +ptp_ocp_timecard_tty_is_visible(struct kobject *kobj, struct attribute *attr, int n)
> +{
> +	struct ptp_ocp *bp = dev_get_drvdata(kobj_to_dev(kobj));
> +	struct ptp_ocp_serial_port *port;
> +	struct device_attribute *dattr;
> +	struct dev_ext_attribute *ea;
> +
> +	if (strncmp(attr->name, "tty", 3))
> +		return attr->mode;
> +
> +	dattr = container_of(attr, struct device_attribute, attr);
> +	ea = container_of(dattr, struct dev_ext_attribute, attr);
> +	port = (void *)((uintptr_t)bp + (uintptr_t)ea->var);

That's crazy pointer math, how are you ensured that it is correct?  Why
isn't there a container_of() thing here instead?

thanks,

greg k-h
Vadim Fedorenko Aug. 13, 2024, 6:24 p.m. UTC | #2
On 13/08/2024 10:33, Greg Kroah-Hartman wrote:
> On Mon, Aug 05, 2024 at 03:04:59PM -0700, Vadim Fedorenko wrote:
>> Starting v6.8 the serial port subsystem changed the hierarchy of devices
>> and symlinks are not working anymore. Previous discussion made it clear
>> that the idea of symlinks for tty devices was wrong by design. Implement
>> additional attributes to expose the information. Fixes tag points to the
>> commit which introduced the change.
>>
>> Fixes: b286f4e87e32 ("serial: core: Move tty and serdev to be children of serial core port device")
>> Signed-off-by: Vadim Fedorenko <vadfed@meta.com>
>> ---
>>   drivers/ptp/ptp_ocp.c | 68 +++++++++++++++++++++++++++++++++----------
>>   1 file changed, 52 insertions(+), 16 deletions(-)
>>
>> diff --git a/drivers/ptp/ptp_ocp.c b/drivers/ptp/ptp_ocp.c
>> index ee2ced88ab34..7a5026656452 100644
>> --- a/drivers/ptp/ptp_ocp.c
>> +++ b/drivers/ptp/ptp_ocp.c
>> @@ -3346,6 +3346,55 @@ static EXT_ATTR_RO(freq, frequency, 1);
>>   static EXT_ATTR_RO(freq, frequency, 2);
>>   static EXT_ATTR_RO(freq, frequency, 3);
>>   
>> +static ssize_t
>> +ptp_ocp_tty_show(struct device *dev, struct device_attribute *attr, char *buf)
>> +{
>> +	struct dev_ext_attribute *ea = to_ext_attr(attr);
>> +	struct ptp_ocp *bp = dev_get_drvdata(dev);
>> +	struct ptp_ocp_serial_port *port;
>> +
>> +	port = (void *)((uintptr_t)bp + (uintptr_t)ea->var);
> 
> That's insane pointer math, how do we know this is correct?
> 
>> +	return sysfs_emit(buf, "ttyS%d", port->line);
>> +}
>> +
>> +static umode_t
>> +ptp_ocp_timecard_tty_is_visible(struct kobject *kobj, struct attribute *attr, int n)
>> +{
>> +	struct ptp_ocp *bp = dev_get_drvdata(kobj_to_dev(kobj));
>> +	struct ptp_ocp_serial_port *port;
>> +	struct device_attribute *dattr;
>> +	struct dev_ext_attribute *ea;
>> +
>> +	if (strncmp(attr->name, "tty", 3))
>> +		return attr->mode;
>> +
>> +	dattr = container_of(attr, struct device_attribute, attr);
>> +	ea = container_of(dattr, struct dev_ext_attribute, attr);
>> +	port = (void *)((uintptr_t)bp + (uintptr_t)ea->var);
> 
> That's crazy pointer math, how are you ensured that it is correct?  Why
> isn't there a container_of() thing here instead?

Well, container_of cannot be used here because the attributes are static
while the function reads dynamic instance. The only values that are
populated into the attributes of the group are offsets.
But I can convert it to a helper which will check that the offset 
provided is the real offset of the structure we expect. And it could be 
reused in both "is_visible" and "show" functions.

> thanks,
> 
> greg k-h
Jiri Slaby Aug. 14, 2024, 5 a.m. UTC | #3
On 13. 08. 24, 20:24, Vadim Fedorenko wrote:
> On 13/08/2024 10:33, Greg Kroah-Hartman wrote:
>> On Mon, Aug 05, 2024 at 03:04:59PM -0700, Vadim Fedorenko wrote:
>>> Starting v6.8 the serial port subsystem changed the hierarchy of devices
>>> and symlinks are not working anymore. Previous discussion made it clear
>>> that the idea of symlinks for tty devices was wrong by design. Implement
>>> additional attributes to expose the information. Fixes tag points to the
>>> commit which introduced the change.
>>>
>>> Fixes: b286f4e87e32 ("serial: core: Move tty and serdev to be 
>>> children of serial core port device")
>>> Signed-off-by: Vadim Fedorenko <vadfed@meta.com>
>>> ---
>>>   drivers/ptp/ptp_ocp.c | 68 +++++++++++++++++++++++++++++++++----------
>>>   1 file changed, 52 insertions(+), 16 deletions(-)
>>>
>>> diff --git a/drivers/ptp/ptp_ocp.c b/drivers/ptp/ptp_ocp.c
>>> index ee2ced88ab34..7a5026656452 100644
>>> --- a/drivers/ptp/ptp_ocp.c
>>> +++ b/drivers/ptp/ptp_ocp.c
>>> @@ -3346,6 +3346,55 @@ static EXT_ATTR_RO(freq, frequency, 1);
>>>   static EXT_ATTR_RO(freq, frequency, 2);
>>>   static EXT_ATTR_RO(freq, frequency, 3);
>>> +static ssize_t
>>> +ptp_ocp_tty_show(struct device *dev, struct device_attribute *attr, 
>>> char *buf)
>>> +{
>>> +    struct dev_ext_attribute *ea = to_ext_attr(attr);
>>> +    struct ptp_ocp *bp = dev_get_drvdata(dev);
>>> +    struct ptp_ocp_serial_port *port;
>>> +
>>> +    port = (void *)((uintptr_t)bp + (uintptr_t)ea->var);
>>
>> That's insane pointer math, how do we know this is correct?
>>
>>> +    return sysfs_emit(buf, "ttyS%d", port->line);
>>> +}
>>> +
>>> +static umode_t
>>> +ptp_ocp_timecard_tty_is_visible(struct kobject *kobj, struct 
>>> attribute *attr, int n)
>>> +{
>>> +    struct ptp_ocp *bp = dev_get_drvdata(kobj_to_dev(kobj));
>>> +    struct ptp_ocp_serial_port *port;
>>> +    struct device_attribute *dattr;
>>> +    struct dev_ext_attribute *ea;
>>> +
>>> +    if (strncmp(attr->name, "tty", 3))
>>> +        return attr->mode;
>>> +
>>> +    dattr = container_of(attr, struct device_attribute, attr);
>>> +    ea = container_of(dattr, struct dev_ext_attribute, attr);
>>> +    port = (void *)((uintptr_t)bp + (uintptr_t)ea->var);
>>
>> That's crazy pointer math, how are you ensured that it is correct?  Why
>> isn't there a container_of() thing here instead?
> 
> Well, container_of cannot be used here because the attributes are static
> while the function reads dynamic instance. The only values that are
> populated into the attributes of the group are offsets.
> But I can convert it to a helper which will check that the offset 
> provided is the real offset of the structure we expect. And it could be 
> reused in both "is_visible" and "show" functions.

Strong NACK against this approach.

What about converting those 4 ports into an array and adding an enum { 
PORT_GNSS, POTR_GNSS2, PORT_MAC, PORT_NMEA }?

thanks,
Vadim Fedorenko Aug. 14, 2024, 8:37 a.m. UTC | #4
On 14/08/2024 06:00, Jiri Slaby wrote:
> On 13. 08. 24, 20:24, Vadim Fedorenko wrote:
>> On 13/08/2024 10:33, Greg Kroah-Hartman wrote:
>>> On Mon, Aug 05, 2024 at 03:04:59PM -0700, Vadim Fedorenko wrote:
>>>> Starting v6.8 the serial port subsystem changed the hierarchy of 
>>>> devices
>>>> and symlinks are not working anymore. Previous discussion made it clear
>>>> that the idea of symlinks for tty devices was wrong by design. 
>>>> Implement
>>>> additional attributes to expose the information. Fixes tag points to 
>>>> the
>>>> commit which introduced the change.
>>>>
>>>> Fixes: b286f4e87e32 ("serial: core: Move tty and serdev to be 
>>>> children of serial core port device")
>>>> Signed-off-by: Vadim Fedorenko <vadfed@meta.com>
>>>> ---
>>>>   drivers/ptp/ptp_ocp.c | 68 
>>>> +++++++++++++++++++++++++++++++++----------
>>>>   1 file changed, 52 insertions(+), 16 deletions(-)
>>>>
>>>> diff --git a/drivers/ptp/ptp_ocp.c b/drivers/ptp/ptp_ocp.c
>>>> index ee2ced88ab34..7a5026656452 100644
>>>> --- a/drivers/ptp/ptp_ocp.c
>>>> +++ b/drivers/ptp/ptp_ocp.c
>>>> @@ -3346,6 +3346,55 @@ static EXT_ATTR_RO(freq, frequency, 1);
>>>>   static EXT_ATTR_RO(freq, frequency, 2);
>>>>   static EXT_ATTR_RO(freq, frequency, 3);
>>>> +static ssize_t
>>>> +ptp_ocp_tty_show(struct device *dev, struct device_attribute *attr, 
>>>> char *buf)
>>>> +{
>>>> +    struct dev_ext_attribute *ea = to_ext_attr(attr);
>>>> +    struct ptp_ocp *bp = dev_get_drvdata(dev);
>>>> +    struct ptp_ocp_serial_port *port;
>>>> +
>>>> +    port = (void *)((uintptr_t)bp + (uintptr_t)ea->var);
>>>
>>> That's insane pointer math, how do we know this is correct?
>>>
>>>> +    return sysfs_emit(buf, "ttyS%d", port->line);
>>>> +}
>>>> +
>>>> +static umode_t
>>>> +ptp_ocp_timecard_tty_is_visible(struct kobject *kobj, struct 
>>>> attribute *attr, int n)
>>>> +{
>>>> +    struct ptp_ocp *bp = dev_get_drvdata(kobj_to_dev(kobj));
>>>> +    struct ptp_ocp_serial_port *port;
>>>> +    struct device_attribute *dattr;
>>>> +    struct dev_ext_attribute *ea;
>>>> +
>>>> +    if (strncmp(attr->name, "tty", 3))
>>>> +        return attr->mode;
>>>> +
>>>> +    dattr = container_of(attr, struct device_attribute, attr);
>>>> +    ea = container_of(dattr, struct dev_ext_attribute, attr);
>>>> +    port = (void *)((uintptr_t)bp + (uintptr_t)ea->var);
>>>
>>> That's crazy pointer math, how are you ensured that it is correct?  Why
>>> isn't there a container_of() thing here instead?
>>
>> Well, container_of cannot be used here because the attributes are static
>> while the function reads dynamic instance. The only values that are
>> populated into the attributes of the group are offsets.
>> But I can convert it to a helper which will check that the offset 
>> provided is the real offset of the structure we expect. And it could 
>> be reused in both "is_visible" and "show" functions.
> 
> Strong NACK against this approach.
> 
> What about converting those 4 ports into an array and adding an enum { 
> PORT_GNSS, POTR_GNSS2, PORT_MAC, PORT_NMEA }?

Why is it a problem? I don't see big difference between these 2
implementations:

struct ptp_ocp_serial_port *get_port(struct ptp_ocp *bp, void *offset)
{
	switch((uintptr_t)offset) {
		case offsetof(struct ptp_ocp, gnss_port):
			return &bp->gnss_port;
		case offsetof(struct ptp_ocp, gnss2_port):
			return &bp->gnss2_port;
		case offsetof(struct ptp_ocp, mac_port):
			return &bp->mac_port;
		case offsetof(struct ptp_ocp, nmea_port):
			return &bp->nmea_port;
	}
	return NULL;
}

and:

struct ptp_ocp_serial_port *get_port(struct ptp_ocp *bp, void *offset)
{
	switch((enum port_type)offset) {
		case PORT_GNSS:
			return &bp->tty_port[PORT_GNSS];
		case PORT_GNSS2:
			return &bp->tty_port[PORT_GNSS2];
		case PORT_MAC:
			return &bp->tty_port[PORT_MAC];
		case PORT_NMEA:
			return &bp->tty_port[PORT_NMEA];
	}
	return NULL;
}

The second option will require more LoC to change the initialization
part of the driver, but will not simplify the access.
If you suggest to use enum value directly, without the check, then
it will not solve the problem of checking the boundary, which Greg
refers to AFAIU.

Thanks!
Jiri Slaby Aug. 14, 2024, 10:30 a.m. UTC | #5
On 14. 08. 24, 10:37, Vadim Fedorenko wrote:
> On 14/08/2024 06:00, Jiri Slaby wrote:
>> On 13. 08. 24, 20:24, Vadim Fedorenko wrote:
>>> On 13/08/2024 10:33, Greg Kroah-Hartman wrote:
>>>> On Mon, Aug 05, 2024 at 03:04:59PM -0700, Vadim Fedorenko wrote:
>>>>> Starting v6.8 the serial port subsystem changed the hierarchy of 
>>>>> devices
>>>>> and symlinks are not working anymore. Previous discussion made it 
>>>>> clear
>>>>> that the idea of symlinks for tty devices was wrong by design. 
>>>>> Implement
>>>>> additional attributes to expose the information. Fixes tag points 
>>>>> to the
>>>>> commit which introduced the change.
>>>>>
>>>>> Fixes: b286f4e87e32 ("serial: core: Move tty and serdev to be 
>>>>> children of serial core port device")
>>>>> Signed-off-by: Vadim Fedorenko <vadfed@meta.com>
>>>>> ---
>>>>>   drivers/ptp/ptp_ocp.c | 68 
>>>>> +++++++++++++++++++++++++++++++++----------
>>>>>   1 file changed, 52 insertions(+), 16 deletions(-)
>>>>>
>>>>> diff --git a/drivers/ptp/ptp_ocp.c b/drivers/ptp/ptp_ocp.c
>>>>> index ee2ced88ab34..7a5026656452 100644
>>>>> --- a/drivers/ptp/ptp_ocp.c
>>>>> +++ b/drivers/ptp/ptp_ocp.c
>>>>> @@ -3346,6 +3346,55 @@ static EXT_ATTR_RO(freq, frequency, 1);
>>>>>   static EXT_ATTR_RO(freq, frequency, 2);
>>>>>   static EXT_ATTR_RO(freq, frequency, 3);
>>>>> +static ssize_t
>>>>> +ptp_ocp_tty_show(struct device *dev, struct device_attribute 
>>>>> *attr, char *buf)
>>>>> +{
>>>>> +    struct dev_ext_attribute *ea = to_ext_attr(attr);
>>>>> +    struct ptp_ocp *bp = dev_get_drvdata(dev);
>>>>> +    struct ptp_ocp_serial_port *port;
>>>>> +
>>>>> +    port = (void *)((uintptr_t)bp + (uintptr_t)ea->var);
>>>>
>>>> That's insane pointer math, how do we know this is correct?
>>>>
>>>>> +    return sysfs_emit(buf, "ttyS%d", port->line);
>>>>> +}
>>>>> +
>>>>> +static umode_t
>>>>> +ptp_ocp_timecard_tty_is_visible(struct kobject *kobj, struct 
>>>>> attribute *attr, int n)
>>>>> +{
>>>>> +    struct ptp_ocp *bp = dev_get_drvdata(kobj_to_dev(kobj));
>>>>> +    struct ptp_ocp_serial_port *port;
>>>>> +    struct device_attribute *dattr;
>>>>> +    struct dev_ext_attribute *ea;
>>>>> +
>>>>> +    if (strncmp(attr->name, "tty", 3))
>>>>> +        return attr->mode;
>>>>> +
>>>>> +    dattr = container_of(attr, struct device_attribute, attr);
>>>>> +    ea = container_of(dattr, struct dev_ext_attribute, attr);
>>>>> +    port = (void *)((uintptr_t)bp + (uintptr_t)ea->var);
>>>>
>>>> That's crazy pointer math, how are you ensured that it is correct?  Why
>>>> isn't there a container_of() thing here instead?
>>>
>>> Well, container_of cannot be used here because the attributes are static
>>> while the function reads dynamic instance. The only values that are
>>> populated into the attributes of the group are offsets.
>>> But I can convert it to a helper which will check that the offset 
>>> provided is the real offset of the structure we expect. And it could 
>>> be reused in both "is_visible" and "show" functions.
>>
>> Strong NACK against this approach.
>>
>> What about converting those 4 ports into an array and adding an enum { 
>> PORT_GNSS, POTR_GNSS2, PORT_MAC, PORT_NMEA }?
> 
> Why is it a problem? I don't see big difference between these 2
> implementations:
> 
> struct ptp_ocp_serial_port *get_port(struct ptp_ocp *bp, void *offset)
> {
>      switch((uintptr_t)offset) {
>          case offsetof(struct ptp_ocp, gnss_port):
>              return &bp->gnss_port;
>          case offsetof(struct ptp_ocp, gnss2_port):
>              return &bp->gnss2_port;
>          case offsetof(struct ptp_ocp, mac_port):
>              return &bp->mac_port;
>          case offsetof(struct ptp_ocp, nmea_port):
>              return &bp->nmea_port;
>      }
>      return NULL;
> }
> 
> and:
> 
> struct ptp_ocp_serial_port *get_port(struct ptp_ocp *bp, void *offset)
> {
>      switch((enum port_type)offset) {
>          case PORT_GNSS:
>              return &bp->tty_port[PORT_GNSS];
>          case PORT_GNSS2:
>              return &bp->tty_port[PORT_GNSS2];
>          case PORT_MAC:
>              return &bp->tty_port[PORT_MAC];
>          case PORT_NMEA:
>              return &bp->tty_port[PORT_NMEA];
>      }
>      return NULL;
> }
> 
> The second option will require more LoC to change the initialization
> part of the driver, but will not simplify the access.
> If you suggest to use enum value directly, without the check, then
> it will not solve the problem of checking the boundary, which Greg
> refers to AFAIU.

Why do you need this get_port() here at all? Simply doing 
bp->tty_port[ea->var] as in already present attrs will do the job, right?

thanks,
Vadim Fedorenko Aug. 15, 2024, 1:40 p.m. UTC | #6
On 14/08/2024 11:30, Jiri Slaby wrote:
> On 14. 08. 24, 10:37, Vadim Fedorenko wrote:
>> On 14/08/2024 06:00, Jiri Slaby wrote:
>>> On 13. 08. 24, 20:24, Vadim Fedorenko wrote:
>>>> On 13/08/2024 10:33, Greg Kroah-Hartman wrote:
>>>>> On Mon, Aug 05, 2024 at 03:04:59PM -0700, Vadim Fedorenko wrote:
>>>>>> Starting v6.8 the serial port subsystem changed the hierarchy of 
>>>>>> devices
>>>>>> and symlinks are not working anymore. Previous discussion made it 
>>>>>> clear
>>>>>> that the idea of symlinks for tty devices was wrong by design. 
>>>>>> Implement
>>>>>> additional attributes to expose the information. Fixes tag points 
>>>>>> to the
>>>>>> commit which introduced the change.
>>>>>>
>>>>>> Fixes: b286f4e87e32 ("serial: core: Move tty and serdev to be 
>>>>>> children of serial core port device")
>>>>>> Signed-off-by: Vadim Fedorenko <vadfed@meta.com>
>>>>>> ---
>>>>>>   drivers/ptp/ptp_ocp.c | 68 ++++++++++++++++++++++++++++++++ 
>>>>>> +----------
>>>>>>   1 file changed, 52 insertions(+), 16 deletions(-)
>>>>>>
>>>>>> diff --git a/drivers/ptp/ptp_ocp.c b/drivers/ptp/ptp_ocp.c
>>>>>> index ee2ced88ab34..7a5026656452 100644
>>>>>> --- a/drivers/ptp/ptp_ocp.c
>>>>>> +++ b/drivers/ptp/ptp_ocp.c
>>>>>> @@ -3346,6 +3346,55 @@ static EXT_ATTR_RO(freq, frequency, 1);
>>>>>>   static EXT_ATTR_RO(freq, frequency, 2);
>>>>>>   static EXT_ATTR_RO(freq, frequency, 3);
>>>>>> +static ssize_t
>>>>>> +ptp_ocp_tty_show(struct device *dev, struct device_attribute 
>>>>>> *attr, char *buf)
>>>>>> +{
>>>>>> +    struct dev_ext_attribute *ea = to_ext_attr(attr);
>>>>>> +    struct ptp_ocp *bp = dev_get_drvdata(dev);
>>>>>> +    struct ptp_ocp_serial_port *port;
>>>>>> +
>>>>>> +    port = (void *)((uintptr_t)bp + (uintptr_t)ea->var);
>>>>>
>>>>> That's insane pointer math, how do we know this is correct?
>>>>>
>>>>>> +    return sysfs_emit(buf, "ttyS%d", port->line);
>>>>>> +}
>>>>>> +
>>>>>> +static umode_t
>>>>>> +ptp_ocp_timecard_tty_is_visible(struct kobject *kobj, struct 
>>>>>> attribute *attr, int n)
>>>>>> +{
>>>>>> +    struct ptp_ocp *bp = dev_get_drvdata(kobj_to_dev(kobj));
>>>>>> +    struct ptp_ocp_serial_port *port;
>>>>>> +    struct device_attribute *dattr;
>>>>>> +    struct dev_ext_attribute *ea;
>>>>>> +
>>>>>> +    if (strncmp(attr->name, "tty", 3))
>>>>>> +        return attr->mode;
>>>>>> +
>>>>>> +    dattr = container_of(attr, struct device_attribute, attr);
>>>>>> +    ea = container_of(dattr, struct dev_ext_attribute, attr);
>>>>>> +    port = (void *)((uintptr_t)bp + (uintptr_t)ea->var);
>>>>>
>>>>> That's crazy pointer math, how are you ensured that it is correct?  
>>>>> Why
>>>>> isn't there a container_of() thing here instead?
>>>>
>>>> Well, container_of cannot be used here because the attributes are 
>>>> static
>>>> while the function reads dynamic instance. The only values that are
>>>> populated into the attributes of the group are offsets.
>>>> But I can convert it to a helper which will check that the offset 
>>>> provided is the real offset of the structure we expect. And it could 
>>>> be reused in both "is_visible" and "show" functions.
>>>
>>> Strong NACK against this approach.
>>>
>>> What about converting those 4 ports into an array and adding an enum 
>>> { PORT_GNSS, POTR_GNSS2, PORT_MAC, PORT_NMEA }?
>>
>> Why is it a problem? I don't see big difference between these 2
>> implementations:
>>
>> struct ptp_ocp_serial_port *get_port(struct ptp_ocp *bp, void *offset)
>> {
>>      switch((uintptr_t)offset) {
>>          case offsetof(struct ptp_ocp, gnss_port):
>>              return &bp->gnss_port;
>>          case offsetof(struct ptp_ocp, gnss2_port):
>>              return &bp->gnss2_port;
>>          case offsetof(struct ptp_ocp, mac_port):
>>              return &bp->mac_port;
>>          case offsetof(struct ptp_ocp, nmea_port):
>>              return &bp->nmea_port;
>>      }
>>      return NULL;
>> }
>>
>> and:
>>
>> struct ptp_ocp_serial_port *get_port(struct ptp_ocp *bp, void *offset)
>> {
>>      switch((enum port_type)offset) {
>>          case PORT_GNSS:
>>              return &bp->tty_port[PORT_GNSS];
>>          case PORT_GNSS2:
>>              return &bp->tty_port[PORT_GNSS2];
>>          case PORT_MAC:
>>              return &bp->tty_port[PORT_MAC];
>>          case PORT_NMEA:
>>              return &bp->tty_port[PORT_NMEA];
>>      }
>>      return NULL;
>> }
>>
>> The second option will require more LoC to change the initialization
>> part of the driver, but will not simplify the access.
>> If you suggest to use enum value directly, without the check, then
>> it will not solve the problem of checking the boundary, which Greg
>> refers to AFAIU.
> 
> Why do you need this get_port() here at all? Simply doing bp- 
>  >tty_port[ea->var] as in already present attrs will do the job, right?
> 

Alright, the v3 is up for review with this way applied,
thanks!

> thanks,
diff mbox series

Patch

diff --git a/drivers/ptp/ptp_ocp.c b/drivers/ptp/ptp_ocp.c
index ee2ced88ab34..7a5026656452 100644
--- a/drivers/ptp/ptp_ocp.c
+++ b/drivers/ptp/ptp_ocp.c
@@ -3346,6 +3346,55 @@  static EXT_ATTR_RO(freq, frequency, 1);
 static EXT_ATTR_RO(freq, frequency, 2);
 static EXT_ATTR_RO(freq, frequency, 3);
 
+static ssize_t
+ptp_ocp_tty_show(struct device *dev, struct device_attribute *attr, char *buf)
+{
+	struct dev_ext_attribute *ea = to_ext_attr(attr);
+	struct ptp_ocp *bp = dev_get_drvdata(dev);
+	struct ptp_ocp_serial_port *port;
+
+	port = (void *)((uintptr_t)bp + (uintptr_t)ea->var);
+	return sysfs_emit(buf, "ttyS%d", port->line);
+}
+
+static umode_t
+ptp_ocp_timecard_tty_is_visible(struct kobject *kobj, struct attribute *attr, int n)
+{
+	struct ptp_ocp *bp = dev_get_drvdata(kobj_to_dev(kobj));
+	struct ptp_ocp_serial_port *port;
+	struct device_attribute *dattr;
+	struct dev_ext_attribute *ea;
+
+	if (strncmp(attr->name, "tty", 3))
+		return attr->mode;
+
+	dattr = container_of(attr, struct device_attribute, attr);
+	ea = container_of(dattr, struct dev_ext_attribute, attr);
+	port = (void *)((uintptr_t)bp + (uintptr_t)ea->var);
+	return port->line == -1 ? 0 : 0444;
+}
+#define EXT_TTY_ATTR_RO(_name, _val)			\
+	struct dev_ext_attribute dev_attr_tty##_name =	\
+		{ __ATTR(tty##_name, 0444, ptp_ocp_tty_show, NULL), (void *)_val }
+
+static EXT_TTY_ATTR_RO(GNSS, offsetof(struct ptp_ocp, gnss_port));
+static EXT_TTY_ATTR_RO(GNSS2, offsetof(struct ptp_ocp, gnss2_port));
+static EXT_TTY_ATTR_RO(MAC, offsetof(struct ptp_ocp, mac_port));
+static EXT_TTY_ATTR_RO(NMEA, offsetof(struct ptp_ocp, nmea_port));
+static struct attribute *ptp_ocp_timecard_tty_attrs[] = {
+	&dev_attr_ttyGNSS.attr.attr,
+	&dev_attr_ttyGNSS2.attr.attr,
+	&dev_attr_ttyMAC.attr.attr,
+	&dev_attr_ttyNMEA.attr.attr,
+	NULL,
+};
+
+static const struct attribute_group ptp_ocp_timecard_tty_group = {
+	.name = "tty",
+	.attrs = ptp_ocp_timecard_tty_attrs,
+	.is_visible = ptp_ocp_timecard_tty_is_visible,
+};
+
 static ssize_t
 serialnum_show(struct device *dev, struct device_attribute *attr, char *buf)
 {
@@ -3775,6 +3824,7 @@  static const struct attribute_group fb_timecard_group = {
 
 static const struct ocp_attr_group fb_timecard_groups[] = {
 	{ .cap = OCP_CAP_BASIC,	    .group = &fb_timecard_group },
+	{ .cap = OCP_CAP_BASIC,	    .group = &ptp_ocp_timecard_tty_group },
 	{ .cap = OCP_CAP_SIGNAL,    .group = &fb_timecard_signal0_group },
 	{ .cap = OCP_CAP_SIGNAL,    .group = &fb_timecard_signal1_group },
 	{ .cap = OCP_CAP_SIGNAL,    .group = &fb_timecard_signal2_group },
@@ -3814,6 +3864,7 @@  static const struct attribute_group art_timecard_group = {
 
 static const struct ocp_attr_group art_timecard_groups[] = {
 	{ .cap = OCP_CAP_BASIC,	    .group = &art_timecard_group },
+	{ .cap = OCP_CAP_BASIC,	    .group = &ptp_ocp_timecard_tty_group },
 	{ },
 };
 
@@ -3841,6 +3892,7 @@  static const struct attribute_group adva_timecard_group = {
 
 static const struct ocp_attr_group adva_timecard_groups[] = {
 	{ .cap = OCP_CAP_BASIC,	    .group = &adva_timecard_group },
+	{ .cap = OCP_CAP_BASIC,	    .group = &ptp_ocp_timecard_tty_group },
 	{ .cap = OCP_CAP_SIGNAL,    .group = &fb_timecard_signal0_group },
 	{ .cap = OCP_CAP_SIGNAL,    .group = &fb_timecard_signal1_group },
 	{ .cap = OCP_CAP_FREQ,	    .group = &fb_timecard_freq0_group },
@@ -4352,22 +4404,6 @@  ptp_ocp_complete(struct ptp_ocp *bp)
 	struct pps_device *pps;
 	char buf[32];
 
-	if (bp->gnss_port.line != -1) {
-		sprintf(buf, "ttyS%d", bp->gnss_port.line);
-		ptp_ocp_link_child(bp, buf, "ttyGNSS");
-	}
-	if (bp->gnss2_port.line != -1) {
-		sprintf(buf, "ttyS%d", bp->gnss2_port.line);
-		ptp_ocp_link_child(bp, buf, "ttyGNSS2");
-	}
-	if (bp->mac_port.line != -1) {
-		sprintf(buf, "ttyS%d", bp->mac_port.line);
-		ptp_ocp_link_child(bp, buf, "ttyMAC");
-	}
-	if (bp->nmea_port.line != -1) {
-		sprintf(buf, "ttyS%d", bp->nmea_port.line);
-		ptp_ocp_link_child(bp, buf, "ttyNMEA");
-	}
 	sprintf(buf, "ptp%d", ptp_clock_index(bp->ptp));
 	ptp_ocp_link_child(bp, buf, "ptp");