diff mbox

[v2,2/3] input: pwm-beeper: add documentation for volume devicetree bindings

Message ID 1475831223-6006-3-git-send-email-frieder.schrempf@exceet.de
State Changes Requested, archived
Headers show

Commit Message

Frieder Schrempf Oct. 7, 2016, 9:08 a.m. UTC
This patch adds the documentation for the devicetree bindings to set
the volume levels.

Signed-off-by: Frieder Schrempf <frieder.schrempf@exceet.de>
---
Changes in v2:
 - split into 3 separate patches
 - make volume properties optional

 .../devicetree/bindings/input/pwm-beeper.txt       | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)

Comments

Rob Herring Oct. 10, 2016, 3:20 p.m. UTC | #1
On Fri, Oct 07, 2016 at 09:08:17AM +0000, Schrempf Frieder wrote:
> This patch adds the documentation for the devicetree bindings to set
> the volume levels.
> 
> Signed-off-by: Frieder Schrempf <frieder.schrempf@exceet.de>
> ---
> Changes in v2:
>  - split into 3 separate patches
>  - make volume properties optional
> 
>  .../devicetree/bindings/input/pwm-beeper.txt       | 22 ++++++++++++++++++++++
>  1 file changed, 22 insertions(+)
> 
> diff --git a/Documentation/devicetree/bindings/input/pwm-beeper.txt b/Documentation/devicetree/bindings/input/pwm-beeper.txt
> index be332ae..6d8ba4e 100644
> --- a/Documentation/devicetree/bindings/input/pwm-beeper.txt
> +++ b/Documentation/devicetree/bindings/input/pwm-beeper.txt
> @@ -5,3 +5,25 @@ Registers a PWM device as beeper.
>  Required properties:
>  - compatible: should be "pwm-beeper"
>  - pwms: phandle to the physical PWM device
> +
> +Optional properties:
> +- volume-levels: Array of distinct volume levels. These need to be in the
> +      range of 0 to 500, while 0 means 0% duty cycle (mute) and 500 means
> +      50% duty cycle (max volume).
> +      Please note that the actual volume of most beepers is highly
> +      non-linear, which means that low volume levels are probably somewhere
> +      in the range of 1 to 30 (0.1-3% duty cycle).

What does the index correspond to? The linear volume?

> +- default-volume-level: the default volume level (index into the
> +      array defined by the "volume-levels" property)
> +
> +The volume level can be set via sysfs under /sys/class/input/inputX/volume.
> +The maximum volume level index can be read from /sys/class/input/inputX/max_volume_level.
> +
> +Example:
> +
> +	pwm-beeper {
> +		compatible = "pwm-beeper";
> +		pwms = <&pwm4 0 5000>;
> +		volume-levels = <0 8 20 40 500>;
> +		default-volume-level = <4>;
> +	};
> -- 
> 1.9.1
--
To unsubscribe from this list: send the line "unsubscribe devicetree" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Frieder Schrempf Oct. 11, 2016, 8:17 a.m. UTC | #2
On 10.10.2016 17:20, Rob Herring wrote:
> On Fri, Oct 07, 2016 at 09:08:17AM +0000, Schrempf Frieder wrote:
>> This patch adds the documentation for the devicetree bindings to set
>> the volume levels.
>>
>> Signed-off-by: Frieder Schrempf <frieder.schrempf@exceet.de>
>> ---
>> Changes in v2:
>>  - split into 3 separate patches
>>  - make volume properties optional
>>
>>  .../devicetree/bindings/input/pwm-beeper.txt       | 22 ++++++++++++++++++++++
>>  1 file changed, 22 insertions(+)
>>
>> diff --git a/Documentation/devicetree/bindings/input/pwm-beeper.txt b/Documentation/devicetree/bindings/input/pwm-beeper.txt
>> index be332ae..6d8ba4e 100644
>> --- a/Documentation/devicetree/bindings/input/pwm-beeper.txt
>> +++ b/Documentation/devicetree/bindings/input/pwm-beeper.txt
>> @@ -5,3 +5,25 @@ Registers a PWM device as beeper.
>>  Required properties:
>>  - compatible: should be "pwm-beeper"
>>  - pwms: phandle to the physical PWM device
>> +
>> +Optional properties:
>> +- volume-levels: Array of distinct volume levels. These need to be in the
>> +      range of 0 to 500, while 0 means 0% duty cycle (mute) and 500 means
>> +      50% duty cycle (max volume).
>> +      Please note that the actual volume of most beepers is highly
>> +      non-linear, which means that low volume levels are probably somewhere
>> +      in the range of 1 to 30 (0.1-3% duty cycle).
>
> What does the index correspond to? The linear volume?

In most cases users probably need linear volume levels (e.g. 0%, 25%, 
50%, 75%, 100%) and in this case the index would indeed correspond to 
the linear perceived volume.

But also non-linear relations are possible (e.g. 0%, 20%, 100%), if the 
user needs for example "mute", "low", "high" as volume levels.

The linearization (defining the corresponding duty cycle for each index) 
depends on the beeper and the perception of the user.

For the example array definition below, I tried different duty cycles 
and found values of 0.8%, 2%, 4%, 50% to be approximately correspondent 
to perceived volume levels of 25%, 50%, 75%, 100% in my case.

>
>> +- default-volume-level: the default volume level (index into the
>> +      array defined by the "volume-levels" property)
>> +
>> +The volume level can be set via sysfs under /sys/class/input/inputX/volume.
>> +The maximum volume level index can be read from /sys/class/input/inputX/max_volume_level.
>> +
>> +Example:
>> +
>> +	pwm-beeper {
>> +		compatible = "pwm-beeper";
>> +		pwms = <&pwm4 0 5000>;
>> +		volume-levels = <0 8 20 40 500>;
>> +		default-volume-level = <4>;
>> +	};
>> --
>> 1.9.1--
To unsubscribe from this list: send the line "unsubscribe devicetree" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Rob Herring Oct. 11, 2016, 1:39 p.m. UTC | #3
On Tue, Oct 11, 2016 at 3:17 AM, Schrempf Frieder
<frieder.schrempf@exceet.de> wrote:
> On 10.10.2016 17:20, Rob Herring wrote:
>> On Fri, Oct 07, 2016 at 09:08:17AM +0000, Schrempf Frieder wrote:
>>> This patch adds the documentation for the devicetree bindings to set
>>> the volume levels.
>>>
>>> Signed-off-by: Frieder Schrempf <frieder.schrempf@exceet.de>
>>> ---
>>> Changes in v2:
>>>  - split into 3 separate patches
>>>  - make volume properties optional
>>>
>>>  .../devicetree/bindings/input/pwm-beeper.txt       | 22 ++++++++++++++++++++++
>>>  1 file changed, 22 insertions(+)
>>>
>>> diff --git a/Documentation/devicetree/bindings/input/pwm-beeper.txt b/Documentation/devicetree/bindings/input/pwm-beeper.txt
>>> index be332ae..6d8ba4e 100644
>>> --- a/Documentation/devicetree/bindings/input/pwm-beeper.txt
>>> +++ b/Documentation/devicetree/bindings/input/pwm-beeper.txt
>>> @@ -5,3 +5,25 @@ Registers a PWM device as beeper.
>>>  Required properties:
>>>  - compatible: should be "pwm-beeper"
>>>  - pwms: phandle to the physical PWM device
>>> +
>>> +Optional properties:
>>> +- volume-levels: Array of distinct volume levels. These need to be in the
>>> +      range of 0 to 500, while 0 means 0% duty cycle (mute) and 500 means
>>> +      50% duty cycle (max volume).
>>> +      Please note that the actual volume of most beepers is highly
>>> +      non-linear, which means that low volume levels are probably somewhere
>>> +      in the range of 1 to 30 (0.1-3% duty cycle).
>>
>> What does the index correspond to? The linear volume?
>
> In most cases users probably need linear volume levels (e.g. 0%, 25%,
> 50%, 75%, 100%) and in this case the index would indeed correspond to
> the linear perceived volume.
>
> But also non-linear relations are possible (e.g. 0%, 20%, 100%), if the
> user needs for example "mute", "low", "high" as volume levels.

Exclude off/mute and this is still linear. Also, the user exposed
levels could be a subset of the defined h/w levels. That should be
independent of DT.

> The linearization (defining the corresponding duty cycle for each index)
> depends on the beeper and the perception of the user.

This has to be a consistent interface across h/w to have a userspace
that can work across h/w. For that, you have to define the binding as
linear. Of course, it's all measured by perception and not completely
accurate which is fine.

> For the example array definition below, I tried different duty cycles
> and found values of 0.8%, 2%, 4%, 50% to be approximately correspondent
> to perceived volume levels of 25%, 50%, 75%, 100% in my case.
>
>>
>>> +- default-volume-level: the default volume level (index into the
>>> +      array defined by the "volume-levels" property)
>>> +
>>> +The volume level can be set via sysfs under /sys/class/input/inputX/volume.
>>> +The maximum volume level index can be read from /sys/class/input/inputX/max_volume_level.

Also, drop this. Not relevant to the binding.

Rob
--
To unsubscribe from this list: send the line "unsubscribe devicetree" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Frieder Schrempf Jan. 19, 2017, 2:40 p.m. UTC | #4
On 11.10.2016 15:39, Rob Herring wrote:
> On Tue, Oct 11, 2016 at 3:17 AM, Schrempf Frieder
> <frieder.schrempf@exceet.de> wrote:
>> On 10.10.2016 17:20, Rob Herring wrote:
>>> On Fri, Oct 07, 2016 at 09:08:17AM +0000, Schrempf Frieder wrote:
>>>> This patch adds the documentation for the devicetree bindings to set
>>>> the volume levels.
>>>>
>>>> Signed-off-by: Frieder Schrempf <frieder.schrempf@exceet.de>
>>>> ---
>>>> Changes in v2:
>>>>  - split into 3 separate patches
>>>>  - make volume properties optional
>>>>
>>>>  .../devicetree/bindings/input/pwm-beeper.txt       | 22 ++++++++++++++++++++++
>>>>  1 file changed, 22 insertions(+)
>>>>
>>>> diff --git a/Documentation/devicetree/bindings/input/pwm-beeper.txt b/Documentation/devicetree/bindings/input/pwm-beeper.txt
>>>> index be332ae..6d8ba4e 100644
>>>> --- a/Documentation/devicetree/bindings/input/pwm-beeper.txt
>>>> +++ b/Documentation/devicetree/bindings/input/pwm-beeper.txt
>>>> @@ -5,3 +5,25 @@ Registers a PWM device as beeper.
>>>>  Required properties:
>>>>  - compatible: should be "pwm-beeper"
>>>>  - pwms: phandle to the physical PWM device
>>>> +
>>>> +Optional properties:
>>>> +- volume-levels: Array of distinct volume levels. These need to be in the
>>>> +      range of 0 to 500, while 0 means 0% duty cycle (mute) and 500 means
>>>> +      50% duty cycle (max volume).
>>>> +      Please note that the actual volume of most beepers is highly
>>>> +      non-linear, which means that low volume levels are probably somewhere
>>>> +      in the range of 1 to 30 (0.1-3% duty cycle).
>>>
>>> What does the index correspond to? The linear volume?
>>
>> In most cases users probably need linear volume levels (e.g. 0%, 25%,
>> 50%, 75%, 100%) and in this case the index would indeed correspond to
>> the linear perceived volume.
>>
>> But also non-linear relations are possible (e.g. 0%, 20%, 100%), if the
>> user needs for example "mute", "low", "high" as volume levels.
>
> Exclude off/mute and this is still linear. Also, the user exposed
> levels could be a subset of the defined h/w levels. That should be
> independent of DT.

Ok
>
>> The linearization (defining the corresponding duty cycle for each index)
>> depends on the beeper and the perception of the user.
>
> This has to be a consistent interface across h/w to have a userspace
> that can work across h/w. For that, you have to define the binding as
> linear. Of course, it's all measured by perception and not completely
> accurate which is fine.

I see. I will resend and change the description to make clear, that the
volume-levels property is meant to specify linear volume levels.
>
>> For the example array definition below, I tried different duty cycles
>> and found values of 0.8%, 2%, 4%, 50% to be approximately correspondent
>> to perceived volume levels of 25%, 50%, 75%, 100% in my case.
>>
>>>
>>>> +- default-volume-level: the default volume level (index into the
>>>> +      array defined by the "volume-levels" property)
>>>> +
>>>> +The volume level can be set via sysfs under /sys/class/input/inputX/volume.
>>>> +The maximum volume level index can be read from /sys/class/input/inputX/max_volume_level.
>
> Also, drop this. Not relevant to the binding.

Ok, I will drop this.
>
> Rob
>
--
To unsubscribe from this list: send the line "unsubscribe devicetree" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Frieder Schrempf Jan. 19, 2017, 3:24 p.m. UTC | #5
Make the driver accept switching volume levels via sysfs.
This can be helpful if the beep/bell sound intensity needs
to be adapted to the environment of the device.

The number of volume levels available and their values can
be specified via device tree (similar to pwm-backlight).

The volume adjustment is done by changing the duty cycle of
the pwm signal.

Changes in v3:
 - update date
 - change description of volume-levels to be used for linear levels

Frieder Schrempf (3):
  input: pwm-beeper: add feature to set volume via sysfs
  input: pwm-beeper: add documentation for volume devicetree bindings
  input: pwm-beeper: add devicetree bindings to set volume levels

 .../ABI/testing/sysfs-class-input-pwm-beeper       |  17 +++
 .../devicetree/bindings/input/pwm-beeper.txt       |  20 ++++
 drivers/input/misc/pwm-beeper.c                    | 116 ++++++++++++++++++++-
 3 files changed, 151 insertions(+), 2 deletions(-)
 create mode 100644 Documentation/ABI/testing/sysfs-class-input-pwm-beeper
Dmitry Torokhov Jan. 19, 2017, 9:29 p.m. UTC | #6
Hi Frieder,

On Thu, Jan 19, 2017 at 04:24:08PM +0100, Frieder Schrempf wrote:
> Make the driver accept switching volume levels via sysfs.
> This can be helpful if the beep/bell sound intensity needs
> to be adapted to the environment of the device.
> 
> The volume adjustment is done by changing the duty cycle of
> the pwm signal.
> 
> This patch adds the sysfs interface with 5 default volume
> levels (0 - mute, 4 - max. volume).
> 
> Signed-off-by: Frieder Schrempf <frieder.schrempf@exceet.de>
> ---
> Changes in v3:
>  - update date
>  
>  .../ABI/testing/sysfs-class-input-pwm-beeper       | 17 ++++++
>  drivers/input/misc/pwm-beeper.c                    | 71 +++++++++++++++++++++-
>  2 files changed, 87 insertions(+), 1 deletion(-)
>  create mode 100644 Documentation/ABI/testing/sysfs-class-input-pwm-beeper
> 
> diff --git a/Documentation/ABI/testing/sysfs-class-input-pwm-beeper b/Documentation/ABI/testing/sysfs-class-input-pwm-beeper
> new file mode 100644
> index 0000000..c878a1d
> --- /dev/null
> +++ b/Documentation/ABI/testing/sysfs-class-input-pwm-beeper
> @@ -0,0 +1,17 @@
> +What:		/sys/class/input/input(x)/volume

Only generic (i.e. applicable to all input devices) attributes can be
present in /sys/class/input/input(x)/, and volume certainly isn't such
attribute. Please move them to the pwm-beeper platform device itself.

> +Date:		January 2017
> +KernelVersion:
> +Contact:	Frieder Schrempf <frieder.schrempf@exceet.de>
> +Description:
> +		Control the volume of this pwm-beeper. Values
> +		are between 0 and max_volume_level. This file will also
> +		show the current volume level stored in the driver.
> +
> +What:		/sys/class/input/input(x)/max_volume_level
> +Date:		January 2017
> +KernelVersion:
> +Contact:	Frieder Schrempf <frieder.schrempf@exceet.de>
> +Description:
> +		This file shows the maximum volume level that can be
> +		assigned to volume.
> +
> diff --git a/drivers/input/misc/pwm-beeper.c b/drivers/input/misc/pwm-beeper.c
> index 5f9655d..3ed21da 100644
> --- a/drivers/input/misc/pwm-beeper.c
> +++ b/drivers/input/misc/pwm-beeper.c
> @@ -1,5 +1,9 @@
>  /*
>   *  Copyright (C) 2010, Lars-Peter Clausen <lars@metafoo.de>
> + *
> + *  Copyright (C) 2016, Frieder Schrempf <frieder.schrempf@exceet.de>
> + *  (volume support)
> + *
>   *  PWM beeper driver
>   *
>   *  This program is free software; you can redistribute it and/or modify it
> @@ -27,16 +31,77 @@ struct pwm_beeper {
>  	struct pwm_device *pwm;
>  	struct work_struct work;
>  	unsigned long period;
> +	unsigned int volume;
> +	unsigned int volume_levels[] = {0, 8, 20, 40, 500};

Does this actually work? Anyway, you are not allowing to set differentr
values in for different beepers, so take the array out of the structure.

> +	unsigned int max_volume_level;
>  };
>  
>  #define HZ_TO_NANOSECONDS(x) (1000000000UL/(x))
>  
> +static ssize_t beeper_show_volume(struct device *dev,
> +		struct device_attribute *attr, char *buf)
> +{
> +	struct pwm_beeper *beeper = dev_get_drvdata(dev);
> +
> +	return sprintf(buf, "%d\n", beeper->volume);
> +}
> +
> +static ssize_t beeper_show_max_volume_level(struct device *dev,
> +		struct device_attribute *attr, char *buf)
> +{
> +	struct pwm_beeper *beeper = dev_get_drvdata(dev);
> +
> +	return sprintf(buf, "%d\n", beeper->max_volume_level);
> +}
> +
> +static ssize_t beeper_store_volume(struct device *dev,
> +		struct device_attribute *attr, const char *buf, size_t count)
> +{
> +	int rc;
> +	struct pwm_beeper *beeper = dev_get_drvdata(dev);
> +	unsigned int volume;
> +
> +	rc = kstrtouint(buf, 0, &volume);
> +	if (rc)
> +		return rc;
> +
> +	rc = -ENXIO;

Why? There are no failures below.

> +	if (volume > beeper->max_volume_level)
> +		volume = beeper->max_volume_level;

Return -EINVAL maybe?

> +	pr_debug("set volume to %u\n", volume);
> +	if (beeper->volume != volume)
> +		beeper->volume = volume;

Why?

> +	rc = count;
> +
> +	return rc;
> +}
> +
> +static DEVICE_ATTR(volume, 0644, beeper_show_volume, beeper_store_volume);
> +static DEVICE_ATTR(max_volume_level, 0644, beeper_show_max_volume_level, NULL);

Drop "level", it is cleaner.

> +
> +static struct attribute *bp_device_attributes[] = {

pwm_beeper_atttributes

> +	&dev_attr_volume.attr,
> +	&dev_attr_max_volume_level.attr,
> +	NULL,
> +};
> +
> +static struct attribute_group bp_device_attr_group = {

pwm_beeper_attribute_group

> +	.attrs = bp_device_attributes,
> +};
> +
> +static const struct attribute_group *bp_device_attr_groups[] = {
> +	&bp_device_attr_group,
> +	NULL,
> +};
> +
>  static void __pwm_beeper_set(struct pwm_beeper *beeper)
>  {
>  	unsigned long period = beeper->period;
>  
>  	if (period) {
> -		pwm_config(beeper->pwm, period / 2, period);
> +		pwm_config(beeper->pwm,
> +			period / 1000 * beeper->volume_levels[beeper->volume],
> +			period);
>  		pwm_enable(beeper->pwm);
>  	} else
>  		pwm_disable(beeper->pwm);
> @@ -123,6 +188,8 @@ static int pwm_beeper_probe(struct platform_device *pdev)
>  
>  	INIT_WORK(&beeper->work, pwm_beeper_work);
>  
> +	beeper->max_volume_level = ARRAY_SIZE(beeper->volume_levels) - 1;
> +
>  	beeper->input = input_allocate_device();
>  	if (!beeper->input) {
>  		dev_err(&pdev->dev, "Failed to allocate input device\n");
> @@ -146,6 +213,8 @@ static int pwm_beeper_probe(struct platform_device *pdev)
>  
>  	input_set_drvdata(beeper->input, beeper);
>  
> +	beeper->input->dev.groups = bp_device_attr_groups;
> +
>  	error = input_register_device(beeper->input);
>  	if (error) {
>  		dev_err(&pdev->dev, "Failed to register input device: %d\n", error);
> -- 
> 2.7.4
> 

Thanks.
Dmitry Torokhov Jan. 19, 2017, 9:30 p.m. UTC | #7
On Thu, Jan 19, 2017 at 04:24:10PM +0100, Frieder Schrempf wrote:
> This patch adds the devicetree bindings to set the volume levels
> and the default volume level.
> 
> Signed-off-by: Frieder Schrempf <frieder.schrempf@exceet.de>
> ---
> Changes in v3:
>  - none
>  
>  drivers/input/misc/pwm-beeper.c | 49 ++++++++++++++++++++++++++++++++++++++---
>  1 file changed, 46 insertions(+), 3 deletions(-)
> 
> diff --git a/drivers/input/misc/pwm-beeper.c b/drivers/input/misc/pwm-beeper.c
> index 3ed21da..a7f9d70 100644
> --- a/drivers/input/misc/pwm-beeper.c
> +++ b/drivers/input/misc/pwm-beeper.c
> @@ -32,7 +32,7 @@ struct pwm_beeper {
>  	struct work_struct work;
>  	unsigned long period;
>  	unsigned int volume;
> -	unsigned int volume_levels[] = {0, 8, 20, 40, 500};
> +	unsigned int *volume_levels;
>  	unsigned int max_volume_level;
>  };
>  
> @@ -161,8 +161,11 @@ static void pwm_beeper_close(struct input_dev *input)
>  static int pwm_beeper_probe(struct platform_device *pdev)
>  {
>  	unsigned long pwm_id = (unsigned long)dev_get_platdata(&pdev->dev);
> +	struct device_node *np = pdev->dev.of_node;
>  	struct pwm_beeper *beeper;
> -	int error;
> +	struct property *prop;
> +	int error, length;
> +	u32 value;
>  
>  	beeper = kzalloc(sizeof(*beeper), GFP_KERNEL);
>  	if (!beeper)
> @@ -188,7 +191,47 @@ static int pwm_beeper_probe(struct platform_device *pdev)
>  
>  	INIT_WORK(&beeper->work, pwm_beeper_work);
>  
> -	beeper->max_volume_level = ARRAY_SIZE(beeper->volume_levels) - 1;
> +	/* determine the number of volume levels */
> +	prop = of_find_property(np, "volume-levels", &length);

Please use generic device properties, not OF-specific ones.

> +	if (!prop) {
> +		dev_dbg(&pdev->dev, "no volume levels specified, using max volume\n");
> +		beeper->max_volume_level = 1;
> +	} else
> +		beeper->max_volume_level = length / sizeof(u32);
> +
> +	/* read volume levels from DT property */
> +	if (beeper->max_volume_level > 0) {
> +		size_t size = sizeof(*beeper->volume_levels) *
> +			beeper->max_volume_level;
> +
> +		beeper->volume_levels = devm_kzalloc(&(pdev->dev), size,
> +			GFP_KERNEL);
> +		if (!beeper->volume_levels)
> +			return -ENOMEM;
> +
> +		if (prop) {
> +			error = of_property_read_u32_array(np, "volume-levels",
> +						beeper->volume_levels,
> +						beeper->max_volume_level);
> +
> +			if (error < 0)
> +				return error;
> +
> +			error = of_property_read_u32(np, "default-volume-level",
> +						   &value);
> +
> +			if (error < 0) {
> +				dev_dbg(&pdev->dev, "no default volume specified, using max volume\n");
> +				value = beeper->max_volume_level - 1;
> +			}
> +		} else {
> +			beeper->volume_levels[0] = 500;
> +			value = 0;
> +		}
> +
> +		beeper->volume = value;
> +		beeper->max_volume_level--;
> +	}
>  
>  	beeper->input = input_allocate_device();
>  	if (!beeper->input) {
> -- 
> 2.7.4
>
Dmitry Torokhov Jan. 19, 2017, 9:37 p.m. UTC | #8
On Thu, Jan 19, 2017 at 04:24:07PM +0100, Frieder Schrempf wrote:
> Make the driver accept switching volume levels via sysfs.
> This can be helpful if the beep/bell sound intensity needs
> to be adapted to the environment of the device.
> 
> The number of volume levels available and their values can
> be specified via device tree (similar to pwm-backlight).
> 
> The volume adjustment is done by changing the duty cycle of
> the pwm signal.

I wonder how this all will mesh up with beepers that have dedicated
amplifiers (support is being added by David Lechner).

Thanks.
David Lechner Jan. 20, 2017, 7:11 p.m. UTC | #9
On 01/19/2017 03:37 PM, Dmitry Torokhov wrote:
> On Thu, Jan 19, 2017 at 04:24:07PM +0100, Frieder Schrempf wrote:
>> Make the driver accept switching volume levels via sysfs.
>> This can be helpful if the beep/bell sound intensity needs
>> to be adapted to the environment of the device.
>>
>> The number of volume levels available and their values can
>> be specified via device tree (similar to pwm-backlight).
>>
>> The volume adjustment is done by changing the duty cycle of
>> the pwm signal.
>
> I wonder how this all will mesh up with beepers that have dedicated
> amplifiers (support is being added by David Lechner).

This will work very well with it. I fact, it is a feature I would like 
to have but I was not sure about a good way to implement it. Please Cc: 
me on future revisions of this series and I will be glad to test it.

One thing that would be nice would be for a more generic way to change 
the volume from userspace. Having a sysfs attribute on the platform 
device will work, but it requires very specific knowledge from any 
userspace program that wants to control the volume. Would it be possible 
to add an alsa mixer volume control or something like that?

--
To unsubscribe from this list: send the line "unsubscribe devicetree" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Frieder Schrempf Feb. 16, 2017, 8:37 p.m. UTC | #10
Hi Dmitry,

On 19.01.2017 22:29, Dmitry Torokhov wrote:
> Hi Frieder,
>
> On Thu, Jan 19, 2017 at 04:24:08PM +0100, Frieder Schrempf wrote:
>> Make the driver accept switching volume levels via sysfs.
>> This can be helpful if the beep/bell sound intensity needs
>> to be adapted to the environment of the device.
>>
>> The volume adjustment is done by changing the duty cycle of
>> the pwm signal.
>>
>> This patch adds the sysfs interface with 5 default volume
>> levels (0 - mute, 4 - max. volume).
>>
>> Signed-off-by: Frieder Schrempf <frieder.schrempf@exceet.de>
>> ---
>> Changes in v3:
>>  - update date
>>
>>  .../ABI/testing/sysfs-class-input-pwm-beeper       | 17 ++++++
>>  drivers/input/misc/pwm-beeper.c                    | 71 +++++++++++++++++++++-
>>  2 files changed, 87 insertions(+), 1 deletion(-)
>>  create mode 100644 Documentation/ABI/testing/sysfs-class-input-pwm-beeper
>>
>> diff --git a/Documentation/ABI/testing/sysfs-class-input-pwm-beeper b/Documentation/ABI/testing/sysfs-class-input-pwm-beeper
>> new file mode 100644
>> index 0000000..c878a1d
>> --- /dev/null
>> +++ b/Documentation/ABI/testing/sysfs-class-input-pwm-beeper
>> @@ -0,0 +1,17 @@
>> +What:		/sys/class/input/input(x)/volume
>
> Only generic (i.e. applicable to all input devices) attributes can be
> present in /sys/class/input/input(x)/, and volume certainly isn't such
> attribute. Please move them to the pwm-beeper platform device itself.

Ok, I will move this in v4.
>
>> +Date:		January 2017
>> +KernelVersion:
>> +Contact:	Frieder Schrempf <frieder.schrempf@exceet.de>
>> +Description:
>> +		Control the volume of this pwm-beeper. Values
>> +		are between 0 and max_volume_level. This file will also
>> +		show the current volume level stored in the driver.
>> +
>> +What:		/sys/class/input/input(x)/max_volume_level
>> +Date:		January 2017
>> +KernelVersion:
>> +Contact:	Frieder Schrempf <frieder.schrempf@exceet.de>
>> +Description:
>> +		This file shows the maximum volume level that can be
>> +		assigned to volume.
>> +
>> diff --git a/drivers/input/misc/pwm-beeper.c b/drivers/input/misc/pwm-beeper.c
>> index 5f9655d..3ed21da 100644
>> --- a/drivers/input/misc/pwm-beeper.c
>> +++ b/drivers/input/misc/pwm-beeper.c
>> @@ -1,5 +1,9 @@
>>  /*
>>   *  Copyright (C) 2010, Lars-Peter Clausen <lars@metafoo.de>
>> + *
>> + *  Copyright (C) 2016, Frieder Schrempf <frieder.schrempf@exceet.de>
>> + *  (volume support)
>> + *
>>   *  PWM beeper driver
>>   *
>>   *  This program is free software; you can redistribute it and/or modify it
>> @@ -27,16 +31,77 @@ struct pwm_beeper {
>>  	struct pwm_device *pwm;
>>  	struct work_struct work;
>>  	unsigned long period;
>> +	unsigned int volume;
>> +	unsigned int volume_levels[] = {0, 8, 20, 40, 500};
>
> Does this actually work? Anyway, you are not allowing to set differentr
> values in for different beepers, so take the array out of the structure.

You're right, this was not really clever. I moved the array allocation 
to probe in v4 as a preparation for the devicetree implementation in the 
following patch.
>
>> +	unsigned int max_volume_level;
>>  };
>>
>>  #define HZ_TO_NANOSECONDS(x) (1000000000UL/(x))
>>
>> +static ssize_t beeper_show_volume(struct device *dev,
>> +		struct device_attribute *attr, char *buf)
>> +{
>> +	struct pwm_beeper *beeper = dev_get_drvdata(dev);
>> +
>> +	return sprintf(buf, "%d\n", beeper->volume);
>> +}
>> +
>> +static ssize_t beeper_show_max_volume_level(struct device *dev,
>> +		struct device_attribute *attr, char *buf)
>> +{
>> +	struct pwm_beeper *beeper = dev_get_drvdata(dev);
>> +
>> +	return sprintf(buf, "%d\n", beeper->max_volume_level);
>> +}
>> +
>> +static ssize_t beeper_store_volume(struct device *dev,
>> +		struct device_attribute *attr, const char *buf, size_t count)
>> +{
>> +	int rc;
>> +	struct pwm_beeper *beeper = dev_get_drvdata(dev);
>> +	unsigned int volume;
>> +
>> +	rc = kstrtouint(buf, 0, &volume);
>> +	if (rc)
>> +		return rc;
>> +
>> +	rc = -ENXIO;
>
> Why? There are no failures below.

Yes, you're right.
>
>> +	if (volume > beeper->max_volume_level)
>> +		volume = beeper->max_volume_level;
>
> Return -EINVAL maybe?

Yes, probably makes sense.
>
>> +	pr_debug("set volume to %u\n", volume);
>> +	if (beeper->volume != volume)
>> +		beeper->volume = volume;
>
> Why?

I took this implementation from the pwm-backlight driver, but you're 
right, this does not seem to be necessary.
>
>> +	rc = count;
>> +
>> +	return rc;
>> +}
>> +
>> +static DEVICE_ATTR(volume, 0644, beeper_show_volume, beeper_store_volume);
>> +static DEVICE_ATTR(max_volume_level, 0644, beeper_show_max_volume_level, NULL);
>
> Drop "level", it is cleaner.

Ok.
>
>> +
>> +static struct attribute *bp_device_attributes[] = {
>
> pwm_beeper_atttributes

Ok.
>
>> +	&dev_attr_volume.attr,
>> +	&dev_attr_max_volume_level.attr,
>> +	NULL,
>> +};
>> +
>> +static struct attribute_group bp_device_attr_group = {
>
> pwm_beeper_attribute_group

Ok.
>
>> +	.attrs = bp_device_attributes,
>> +};
>> +
>> +static const struct attribute_group *bp_device_attr_groups[] = {
>> +	&bp_device_attr_group,
>> +	NULL,
>> +};
>> +
>>  static void __pwm_beeper_set(struct pwm_beeper *beeper)
>>  {
>>  	unsigned long period = beeper->period;
>>
>>  	if (period) {
>> -		pwm_config(beeper->pwm, period / 2, period);
>> +		pwm_config(beeper->pwm,
>> +			period / 1000 * beeper->volume_levels[beeper->volume],
>> +			period);
>>  		pwm_enable(beeper->pwm);
>>  	} else
>>  		pwm_disable(beeper->pwm);
>> @@ -123,6 +188,8 @@ static int pwm_beeper_probe(struct platform_device *pdev)
>>
>>  	INIT_WORK(&beeper->work, pwm_beeper_work);
>>
>> +	beeper->max_volume_level = ARRAY_SIZE(beeper->volume_levels) - 1;
>> +
>>  	beeper->input = input_allocate_device();
>>  	if (!beeper->input) {
>>  		dev_err(&pdev->dev, "Failed to allocate input device\n");
>> @@ -146,6 +213,8 @@ static int pwm_beeper_probe(struct platform_device *pdev)
>>
>>  	input_set_drvdata(beeper->input, beeper);
>>
>> +	beeper->input->dev.groups = bp_device_attr_groups;
>> +
>>  	error = input_register_device(beeper->input);
>>  	if (error) {
>>  		dev_err(&pdev->dev, "Failed to register input device: %d\n", error);
>> --
>> 2.7.4
>>
>
> Thanks.
>
--
To unsubscribe from this list: send the line "unsubscribe devicetree" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Frieder Schrempf Feb. 16, 2017, 8:40 p.m. UTC | #11
On 19.01.2017 22:30, Dmitry Torokhov wrote:
> On Thu, Jan 19, 2017 at 04:24:10PM +0100, Frieder Schrempf wrote:
>> This patch adds the devicetree bindings to set the volume levels
>> and the default volume level.
>>
>> Signed-off-by: Frieder Schrempf <frieder.schrempf@exceet.de>
>> ---
>> Changes in v3:
>>  - none
>>
>>  drivers/input/misc/pwm-beeper.c | 49 ++++++++++++++++++++++++++++++++++++++---
>>  1 file changed, 46 insertions(+), 3 deletions(-)
>>
>> diff --git a/drivers/input/misc/pwm-beeper.c b/drivers/input/misc/pwm-beeper.c
>> index 3ed21da..a7f9d70 100644
>> --- a/drivers/input/misc/pwm-beeper.c
>> +++ b/drivers/input/misc/pwm-beeper.c
>> @@ -32,7 +32,7 @@ struct pwm_beeper {
>>  	struct work_struct work;
>>  	unsigned long period;
>>  	unsigned int volume;
>> -	unsigned int volume_levels[] = {0, 8, 20, 40, 500};
>> +	unsigned int *volume_levels;
>>  	unsigned int max_volume_level;
>>  };
>>
>> @@ -161,8 +161,11 @@ static void pwm_beeper_close(struct input_dev *input)
>>  static int pwm_beeper_probe(struct platform_device *pdev)
>>  {
>>  	unsigned long pwm_id = (unsigned long)dev_get_platdata(&pdev->dev);
>> +	struct device_node *np = pdev->dev.of_node;
>>  	struct pwm_beeper *beeper;
>> -	int error;
>> +	struct property *prop;
>> +	int error, length;
>> +	u32 value;
>>
>>  	beeper = kzalloc(sizeof(*beeper), GFP_KERNEL);
>>  	if (!beeper)
>> @@ -188,7 +191,47 @@ static int pwm_beeper_probe(struct platform_device *pdev)
>>
>>  	INIT_WORK(&beeper->work, pwm_beeper_work);
>>
>> -	beeper->max_volume_level = ARRAY_SIZE(beeper->volume_levels) - 1;
>> +	/* determine the number of volume levels */
>> +	prop = of_find_property(np, "volume-levels", &length);
>
> Please use generic device properties, not OF-specific ones.

Ok, I will change this in v4.
>
>> +	if (!prop) {
>> +		dev_dbg(&pdev->dev, "no volume levels specified, using max volume\n");
>> +		beeper->max_volume_level = 1;
>> +	} else
>> +		beeper->max_volume_level = length / sizeof(u32);
>> +
>> +	/* read volume levels from DT property */
>> +	if (beeper->max_volume_level > 0) {
>> +		size_t size = sizeof(*beeper->volume_levels) *
>> +			beeper->max_volume_level;
>> +
>> +		beeper->volume_levels = devm_kzalloc(&(pdev->dev), size,
>> +			GFP_KERNEL);
>> +		if (!beeper->volume_levels)
>> +			return -ENOMEM;
>> +
>> +		if (prop) {
>> +			error = of_property_read_u32_array(np, "volume-levels",
>> +						beeper->volume_levels,
>> +						beeper->max_volume_level);
>> +
>> +			if (error < 0)
>> +				return error;
>> +
>> +			error = of_property_read_u32(np, "default-volume-level",
>> +						   &value);
>> +
>> +			if (error < 0) {
>> +				dev_dbg(&pdev->dev, "no default volume specified, using max volume\n");
>> +				value = beeper->max_volume_level - 1;
>> +			}
>> +		} else {
>> +			beeper->volume_levels[0] = 500;
>> +			value = 0;
>> +		}
>> +
>> +		beeper->volume = value;
>> +		beeper->max_volume_level--;
>> +	}
>>
>>  	beeper->input = input_allocate_device();
>>  	if (!beeper->input) {
>> --
>> 2.7.4
>>
>
--
To unsubscribe from this list: send the line "unsubscribe devicetree" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Frieder Schrempf Feb. 16, 2017, 9:08 p.m. UTC | #12
Make the driver accept switching volume levels via sysfs.
This can be helpful if the beep/bell sound intensity needs
to be adapted to the environment of the device.

The number of volume levels available and their values can
be specified via device tree (similar to pwm-backlight).

The volume adjustment is done by changing the duty cycle of
the pwm signal.

Changes in v4:
 - move sysfs attributes from class/input to devices/pwm-beeper
 - rename max_volume_level to max_volume
 - move array allocation to probe function
 - rename attribute structs
 - remove needless code
 - update date
 - use generic device properties instead of dt properties

Frieder Schrempf (3):
  input: pwm-beeper: add feature to set volume via sysfs
  input: pwm-beeper: add documentation for volume devicetree bindings
  input: pwm-beeper: add devicetree bindings to set volume levels

 Documentation/ABI/testing/sysfs-devices-pwm-beeper |  17 ++++
 .../devicetree/bindings/input/pwm-beeper.txt       |  20 ++++
 drivers/input/misc/pwm-beeper.c                    | 111 ++++++++++++++++++++-
 3 files changed, 146 insertions(+), 2 deletions(-)
 create mode 100644 Documentation/ABI/testing/sysfs-devices-pwm-beeper
Frieder Schrempf Feb. 16, 2017, 9:15 p.m. UTC | #13
Hello David,

On 20.01.2017 20:11, David Lechner wrote:
> On 01/19/2017 03:37 PM, Dmitry Torokhov wrote:
>> On Thu, Jan 19, 2017 at 04:24:07PM +0100, Frieder Schrempf wrote:
>>> Make the driver accept switching volume levels via sysfs.
>>> This can be helpful if the beep/bell sound intensity needs
>>> to be adapted to the environment of the device.
>>>
>>> The number of volume levels available and their values can
>>> be specified via device tree (similar to pwm-backlight).
>>>
>>> The volume adjustment is done by changing the duty cycle of
>>> the pwm signal.
>>
>> I wonder how this all will mesh up with beepers that have dedicated
>> amplifiers (support is being added by David Lechner).
>
> This will work very well with it. I fact, it is a feature I would like
> to have but I was not sure about a good way to implement it. Please Cc:
> me on future revisions of this series and I will be glad to test it.

I have just send v4.
>
> One thing that would be nice would be for a more generic way to change
> the volume from userspace. Having a sysfs attribute on the platform
> device will work, but it requires very specific knowledge from any
> userspace program that wants to control the volume. Would it be possible
> to add an alsa mixer volume control or something like that?

An alsa mixer control for the pwm-beeper volume sounds nice, but 
unfortunately I have no idea how one would implement this, or if this is 
even possible.
>
--
To unsubscribe from this list: send the line "unsubscribe devicetree" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
David Lechner Feb. 16, 2017, 9:44 p.m. UTC | #14
On 02/16/2017 03:15 PM, Frieder Schrempf wrote:
> Hello David,
>
> On 20.01.2017 20:11, David Lechner wrote:
>> On 01/19/2017 03:37 PM, Dmitry Torokhov wrote:
>>> On Thu, Jan 19, 2017 at 04:24:07PM +0100, Frieder Schrempf wrote:
>>>> Make the driver accept switching volume levels via sysfs.
>>>> This can be helpful if the beep/bell sound intensity needs
>>>> to be adapted to the environment of the device.
>>>>
>>>> The number of volume levels available and their values can
>>>> be specified via device tree (similar to pwm-backlight).
>>>>
>>>> The volume adjustment is done by changing the duty cycle of
>>>> the pwm signal.
>>>
>>> I wonder how this all will mesh up with beepers that have dedicated
>>> amplifiers (support is being added by David Lechner).
>>
>> This will work very well with it. I fact, it is a feature I would like
>> to have but I was not sure about a good way to implement it. Please Cc:
>> me on future revisions of this series and I will be glad to test it.
>
> I have just send v4.
>>
>> One thing that would be nice would be for a more generic way to change
>> the volume from userspace. Having a sysfs attribute on the platform
>> device will work, but it requires very specific knowledge from any
>> userspace program that wants to control the volume. Would it be possible
>> to add an alsa mixer volume control or something like that?
>
> An alsa mixer control for the pwm-beeper volume sounds nice, but
> unfortunately I have no idea how one would implement this, or if this is
> even possible.
>>


I know it is possible because I have done it. ;-)

https://github.com/ev3dev/lego-linux-drivers/blob/master/evb/evb_sound.c

The driver in the link above does PCM playback using PWM. But, it also 
included an input device similar to pwm-beeper and it includes an ALSA 
volume control specifically for the beeper.
--
To unsubscribe from this list: send the line "unsubscribe devicetree" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Frieder Schrempf Feb. 17, 2017, 9:54 a.m. UTC | #15
Make the driver accept switching volume levels via sysfs.
This can be helpful if the beep/bell sound intensity needs
to be adapted to the environment of the device.

The number of volume levels available and their values can
be specified via device tree (similar to pwm-backlight).

The volume adjustment is done by changing the duty cycle of
the pwm signal.

Changes in v5:
 - fix renaming of max_volume_level to max_volume
 - remove needless variable declaration

Frieder Schrempf (3):
  input: pwm-beeper: add feature to set volume via sysfs
  input: pwm-beeper: add documentation for volume devicetree bindings
  input: pwm-beeper: add devicetree bindings to set volume levels

 Documentation/ABI/testing/sysfs-devices-pwm-beeper |  17 ++++
 .../devicetree/bindings/input/pwm-beeper.txt       |  20 ++++
 drivers/input/misc/pwm-beeper.c                    | 110 ++++++++++++++++++++-
 3 files changed, 145 insertions(+), 2 deletions(-)
 create mode 100644 Documentation/ABI/testing/sysfs-devices-pwm-beeper
Frieder Schrempf Feb. 17, 2017, 10:01 a.m. UTC | #16
On 16.02.2017 22:44, David Lechner wrote:
> On 02/16/2017 03:15 PM, Frieder Schrempf wrote:
>> Hello David,
>>
>> On 20.01.2017 20:11, David Lechner wrote:
>>> On 01/19/2017 03:37 PM, Dmitry Torokhov wrote:
>>>> On Thu, Jan 19, 2017 at 04:24:07PM +0100, Frieder Schrempf wrote:
>>>>> Make the driver accept switching volume levels via sysfs.
>>>>> This can be helpful if the beep/bell sound intensity needs
>>>>> to be adapted to the environment of the device.
>>>>>
>>>>> The number of volume levels available and their values can
>>>>> be specified via device tree (similar to pwm-backlight).
>>>>>
>>>>> The volume adjustment is done by changing the duty cycle of
>>>>> the pwm signal.
>>>>
>>>> I wonder how this all will mesh up with beepers that have dedicated
>>>> amplifiers (support is being added by David Lechner).
>>>
>>> This will work very well with it. I fact, it is a feature I would like
>>> to have but I was not sure about a good way to implement it. Please Cc:
>>> me on future revisions of this series and I will be glad to test it.
>>
>> I have just send v4.
>>>
>>> One thing that would be nice would be for a more generic way to change
>>> the volume from userspace. Having a sysfs attribute on the platform
>>> device will work, but it requires very specific knowledge from any
>>> userspace program that wants to control the volume. Would it be possible
>>> to add an alsa mixer volume control or something like that?
>>
>> An alsa mixer control for the pwm-beeper volume sounds nice, but
>> unfortunately I have no idea how one would implement this, or if this is
>> even possible.
>>>
>
>
> I know it is possible because I have done it. ;-)
>
> https://github.com/ev3dev/lego-linux-drivers/blob/master/evb/evb_sound.c
>
> The driver in the link above does PCM playback using PWM. But, it also
> included an input device similar to pwm-beeper and it includes an ALSA
> volume control specifically for the beeper.

Aha, thanks. Doesn't look too complicated. I think I will play with this 
a bit, when I have time. So maybe the sysfs volume control can be 
replaced with a proper volume mixer control at some point.
--
To unsubscribe from this list: send the line "unsubscribe devicetree" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
diff mbox

Patch

diff --git a/Documentation/devicetree/bindings/input/pwm-beeper.txt b/Documentation/devicetree/bindings/input/pwm-beeper.txt
index be332ae..6d8ba4e 100644
--- a/Documentation/devicetree/bindings/input/pwm-beeper.txt
+++ b/Documentation/devicetree/bindings/input/pwm-beeper.txt
@@ -5,3 +5,25 @@  Registers a PWM device as beeper.
 Required properties:
 - compatible: should be "pwm-beeper"
 - pwms: phandle to the physical PWM device
+
+Optional properties:
+- volume-levels: Array of distinct volume levels. These need to be in the
+      range of 0 to 500, while 0 means 0% duty cycle (mute) and 500 means
+      50% duty cycle (max volume).
+      Please note that the actual volume of most beepers is highly
+      non-linear, which means that low volume levels are probably somewhere
+      in the range of 1 to 30 (0.1-3% duty cycle).
+- default-volume-level: the default volume level (index into the
+      array defined by the "volume-levels" property)
+
+The volume level can be set via sysfs under /sys/class/input/inputX/volume.
+The maximum volume level index can be read from /sys/class/input/inputX/max_volume_level.
+
+Example:
+
+	pwm-beeper {
+		compatible = "pwm-beeper";
+		pwms = <&pwm4 0 5000>;
+		volume-levels = <0 8 20 40 500>;
+		default-volume-level = <4>;
+	};