[linux-2.6-block.git] / drivers / input / misc / pwm-beeper.c

// SPDX-License-Identifier: GPL-2.0-or-later
/*
 *  Copyright (C) 2010, Lars-Peter Clausen <lars@metafoo.de>
 *  PWM beeper driver
 */

#include <linux/input.h>
#include <linux/regulator/consumer.h>
#include <linux/module.h>
#include <linux/kernel.h>
#include <linux/of.h>
#include <linux/platform_device.h>
#include <linux/property.h>
#include <linux/pwm.h>
#include <linux/slab.h>
#include <linux/workqueue.h>

struct pwm_beeper {
	struct input_dev *input;
	struct pwm_device *pwm;
	struct regulator *amplifier;
	struct work_struct work;
	unsigned long period;
	unsigned int bell_frequency;
	bool suspended;
	bool amplifier_on;
};

#define HZ_TO_NANOSECONDS(x) (1000000000UL/(x))

static int pwm_beeper_on(struct pwm_beeper *beeper, unsigned long period)
{
	struct pwm_state state;
	int error;

	pwm_get_state(beeper->pwm, &state);

	state.enabled = true;
	state.period = period;
	pwm_set_relative_duty_cycle(&state, 50, 100);

	error = pwm_apply_might_sleep(beeper->pwm, &state);
	if (error)
		return error;

	if (!beeper->amplifier_on) {
		error = regulator_enable(beeper->amplifier);
		if (error) {
			pwm_disable(beeper->pwm);
			return error;
		}

		beeper->amplifier_on = true;
	}

	return 0;
}

static void pwm_beeper_off(struct pwm_beeper *beeper)
{
	if (beeper->amplifier_on) {
		regulator_disable(beeper->amplifier);
		beeper->amplifier_on = false;
	}

	pwm_disable(beeper->pwm);
}

static void pwm_beeper_work(struct work_struct *work)
{
	struct pwm_beeper *beeper = container_of(work, struct pwm_beeper, work);
	unsigned long period = READ_ONCE(beeper->period);

	if (period)
		pwm_beeper_on(beeper, period);
	else
		pwm_beeper_off(beeper);
}

static int pwm_beeper_event(struct input_dev *input,
			    unsigned int type, unsigned int code, int value)
{
	struct pwm_beeper *beeper = input_get_drvdata(input);

	if (type != EV_SND || value < 0)
		return -EINVAL;

	switch (code) {
	case SND_BELL:
		value = value ? beeper->bell_frequency : 0;
		break;
	case SND_TONE:
		break;
	default:
		return -EINVAL;
	}

	if (value == 0)
		beeper->period = 0;
	else
		beeper->period = HZ_TO_NANOSECONDS(value);

	if (!beeper->suspended)
		schedule_work(&beeper->work);

	return 0;
}

static void pwm_beeper_stop(struct pwm_beeper *beeper)
{
	cancel_work_sync(&beeper->work);
	pwm_beeper_off(beeper);
}

static void pwm_beeper_close(struct input_dev *input)
{
	struct pwm_beeper *beeper = input_get_drvdata(input);

	pwm_beeper_stop(beeper);
}

static int pwm_beeper_probe(struct platform_device *pdev)
{
	struct device *dev = &pdev->dev;
	struct pwm_beeper *beeper;
	struct pwm_state state;
	u32 bell_frequency;
	int error;

	beeper = devm_kzalloc(dev, sizeof(*beeper), GFP_KERNEL);
	if (!beeper)
		return -ENOMEM;

	beeper->pwm = devm_pwm_get(dev, NULL);
	if (IS_ERR(beeper->pwm))
		return dev_err_probe(dev, PTR_ERR(beeper->pwm), "Failed to request PWM device\n");

	/* Sync up PWM state and ensure it is off. */
	pwm_init_state(beeper->pwm, &state);
	state.enabled = false;
	error = pwm_apply_might_sleep(beeper->pwm, &state);
	if (error) {
		dev_err(dev, "failed to apply initial PWM state: %d\n",
			error);
		return error;
	}

	beeper->amplifier = devm_regulator_get(dev, "amp");
	if (IS_ERR(beeper->amplifier))
		return dev_err_probe(dev, PTR_ERR(beeper->amplifier),
				     "Failed to get 'amp' regulator\n");

	INIT_WORK(&beeper->work, pwm_beeper_work);

	error = device_property_read_u32(dev, "beeper-hz", &bell_frequency);
	if (error) {
		bell_frequency = 1000;
		dev_dbg(dev,
			"failed to parse 'beeper-hz' property, using default: %uHz\n",
			bell_frequency);
	}

	beeper->bell_frequency = bell_frequency;

	beeper->input = devm_input_allocate_device(dev);
	if (!beeper->input) {
		dev_err(dev, "Failed to allocate input device\n");
		return -ENOMEM;
	}

	beeper->input->name = "pwm-beeper";
	beeper->input->phys = "pwm/input0";
	beeper->input->id.bustype = BUS_HOST;
	beeper->input->id.vendor = 0x001f;
	beeper->input->id.product = 0x0001;
	beeper->input->id.version = 0x0100;

	input_set_capability(beeper->input, EV_SND, SND_TONE);
	input_set_capability(beeper->input, EV_SND, SND_BELL);

	beeper->input->event = pwm_beeper_event;
	beeper->input->close = pwm_beeper_close;

	input_set_drvdata(beeper->input, beeper);

	error = input_register_device(beeper->input);
	if (error) {
		dev_err(dev, "Failed to register input device: %d\n", error);
		return error;
	}

	platform_set_drvdata(pdev, beeper);

	return 0;
}

static int pwm_beeper_suspend(struct device *dev)
{
	struct pwm_beeper *beeper = dev_get_drvdata(dev);

	/*
	 * Spinlock is taken here is not to protect write to
	 * beeper->suspended, but to ensure that pwm_beeper_event
	 * does not re-submit work once flag is set.
	 */
	scoped_guard(spinlock_irq, &beeper->input->event_lock) {
		beeper->suspended = true;
	}

	pwm_beeper_stop(beeper);

	return 0;
}

static int pwm_beeper_resume(struct device *dev)
{
	struct pwm_beeper *beeper = dev_get_drvdata(dev);

	scoped_guard(spinlock_irq, &beeper->input->event_lock) {
		beeper->suspended = false;
	}

	/* Let worker figure out if we should resume beeping */
	schedule_work(&beeper->work);

	return 0;
}

static DEFINE_SIMPLE_DEV_PM_OPS(pwm_beeper_pm_ops,
				pwm_beeper_suspend, pwm_beeper_resume);

#ifdef CONFIG_OF
static const struct of_device_id pwm_beeper_match[] = {
	{ .compatible = "pwm-beeper", },
	{ },
};
MODULE_DEVICE_TABLE(of, pwm_beeper_match);
#endif

static struct platform_driver pwm_beeper_driver = {
	.probe	= pwm_beeper_probe,
	.driver = {
		.name	= "pwm-beeper",
		.pm	= pm_sleep_ptr(&pwm_beeper_pm_ops),
		.of_match_table = of_match_ptr(pwm_beeper_match),
	},
};
module_platform_driver(pwm_beeper_driver);

MODULE_AUTHOR("Lars-Peter Clausen <lars@metafoo.de>");
MODULE_DESCRIPTION("PWM beeper driver");
MODULE_LICENSE("GPL");
MODULE_ALIAS("platform:pwm-beeper");
Commit	Line	Data
a912e80b	1	// SPDX-License-Identifier: GPL-2.0-or-later
e22739d0 LPC	2	/*
	3	* Copyright (C) 2010, Lars-Peter Clausen <lars@metafoo.de>
	4	* PWM beeper driver
e22739d0 LPC	5	*/
	6
	7	#include <linux/input.h>
9e549244	8	#include <linux/regulator/consumer.h>
e22739d0 LPC	9	#include <linux/module.h>
e22739d0 LPC	10	#include <linux/kernel.h>
9dbe4c32	11	#include <linux/of.h>
e22739d0	12	#include <linux/platform_device.h>
fad358a0	13	#include <linux/property.h>
e22739d0 LPC	14	#include <linux/pwm.h>
e22739d0 LPC	15	#include <linux/slab.h>
f49cf3b8	16	#include <linux/workqueue.h>
e22739d0 LPC	17
	18	struct pwm_beeper {
	19	struct input_dev *input;
	20	struct pwm_device *pwm;
9e549244	21	struct regulator *amplifier;
f49cf3b8	22	struct work_struct work;
e22739d0	23	unsigned long period;
fad358a0	24	unsigned int bell_frequency;
e9728f0d	25	bool suspended;
9e549244	26	bool amplifier_on;
e22739d0 LPC	27	};
	28
	29	#define HZ_TO_NANOSECONDS(x) (1000000000UL/(x))
	30
9e549244	31	static int pwm_beeper_on(struct pwm_beeper *beeper, unsigned long period)
f49cf3b8	32	{
2de8b411	33	struct pwm_state state;
9e549244 DL	34	int error;
9e549244 DL	35
2de8b411 DT	36	pwm_get_state(beeper->pwm, &state);
	37
	38	state.enabled = true;
	39	state.period = period;
	40	pwm_set_relative_duty_cycle(&state, 50, 100);
9e549244	41
c748a6d7	42	error = pwm_apply_might_sleep(beeper->pwm, &state);
9e549244 DL	43	if (error)
	44	return error;
	45
	46	if (!beeper->amplifier_on) {
	47	error = regulator_enable(beeper->amplifier);
	48	if (error) {
	49	pwm_disable(beeper->pwm);
	50	return error;
	51	}
f49cf3b8	52
9e549244 DL	53	beeper->amplifier_on = true;
	54	}
	55
	56	return 0;
	57	}
	58
	59	static void pwm_beeper_off(struct pwm_beeper *beeper)
	60	{
	61	if (beeper->amplifier_on) {
	62	regulator_disable(beeper->amplifier);
	63	beeper->amplifier_on = false;
	64	}
	65
	66	pwm_disable(beeper->pwm);
f49cf3b8 MS	67	}
	68
	69	static void pwm_beeper_work(struct work_struct *work)
	70	{
9e549244 DL	71	struct pwm_beeper *beeper = container_of(work, struct pwm_beeper, work);
9e549244 DL	72	unsigned long period = READ_ONCE(beeper->period);
f49cf3b8	73
9e549244 DL	74	if (period)
	75	pwm_beeper_on(beeper, period);
	76	else
	77	pwm_beeper_off(beeper);
f49cf3b8 MS	78	}
f49cf3b8 MS	79
e22739d0 LPC	80	static int pwm_beeper_event(struct input_dev *input,
	81	unsigned int type, unsigned int code, int value)
	82	{
e22739d0	83	struct pwm_beeper *beeper = input_get_drvdata(input);
e22739d0 LPC	84
	85	if (type != EV_SND \|\| value < 0)
	86	return -EINVAL;
	87
	88	switch (code) {
	89	case SND_BELL:
fad358a0	90	value = value ? beeper->bell_frequency : 0;
e22739d0 LPC	91	break;
	92	case SND_TONE:
	93	break;
	94	default:
	95	return -EINVAL;
	96	}
	97
f49cf3b8 MS	98	if (value == 0)
	99	beeper->period = 0;
	100	else
	101	beeper->period = HZ_TO_NANOSECONDS(value);
	102
e9728f0d DT	103	if (!beeper->suspended)
e9728f0d DT	104	schedule_work(&beeper->work);
e22739d0 LPC	105
	106	return 0;
	107	}
	108
f49cf3b8 MS	109	static void pwm_beeper_stop(struct pwm_beeper *beeper)
	110	{
	111	cancel_work_sync(&beeper->work);
9e549244	112	pwm_beeper_off(beeper);
f49cf3b8 MS	113	}
	114
	115	static void pwm_beeper_close(struct input_dev *input)
	116	{
	117	struct pwm_beeper *beeper = input_get_drvdata(input);
	118
	119	pwm_beeper_stop(beeper);
	120	}
	121
5298cc4c	122	static int pwm_beeper_probe(struct platform_device *pdev)
e22739d0	123	{
bcf4b046	124	struct device *dev = &pdev->dev;
e22739d0	125	struct pwm_beeper *beeper;
2de8b411	126	struct pwm_state state;
fad358a0	127	u32 bell_frequency;
e22739d0 LPC	128	int error;
e22739d0 LPC	129
bcf4b046	130	beeper = devm_kzalloc(dev, sizeof(*beeper), GFP_KERNEL);
e22739d0 LPC	131	if (!beeper)
	132	return -ENOMEM;
	133
bcf4b046	134	beeper->pwm = devm_pwm_get(dev, NULL);
c4834f4a KK	135	if (IS_ERR(beeper->pwm))
c4834f4a KK	136	return dev_err_probe(dev, PTR_ERR(beeper->pwm), "Failed to request PWM device\n");
e22739d0	137
2de8b411 DT	138	/* Sync up PWM state and ensure it is off. */
	139	pwm_init_state(beeper->pwm, &state);
	140	state.enabled = false;
c748a6d7	141	error = pwm_apply_might_sleep(beeper->pwm, &state);
2de8b411 DT	142	if (error) {
	143	dev_err(dev, "failed to apply initial PWM state: %d\n",
	144	error);
	145	return error;
	146	}
cfae56f1	147
9e549244	148	beeper->amplifier = devm_regulator_get(dev, "amp");
c4834f4a KK	149	if (IS_ERR(beeper->amplifier))
	150	return dev_err_probe(dev, PTR_ERR(beeper->amplifier),
	151	"Failed to get 'amp' regulator\n");
9e549244	152
f49cf3b8 MS	153	INIT_WORK(&beeper->work, pwm_beeper_work);
f49cf3b8 MS	154
fad358a0 GB	155	error = device_property_read_u32(dev, "beeper-hz", &bell_frequency);
	156	if (error) {
	157	bell_frequency = 1000;
	158	dev_dbg(dev,
	159	"failed to parse 'beeper-hz' property, using default: %uHz\n",
	160	bell_frequency);
	161	}
	162
	163	beeper->bell_frequency = bell_frequency;
	164
bcf4b046	165	beeper->input = devm_input_allocate_device(dev);
e22739d0	166	if (!beeper->input) {
bcf4b046 DT	167	dev_err(dev, "Failed to allocate input device\n");
bcf4b046 DT	168	return -ENOMEM;
e22739d0	169	}
e22739d0 LPC	170
	171	beeper->input->name = "pwm-beeper";
	172	beeper->input->phys = "pwm/input0";
	173	beeper->input->id.bustype = BUS_HOST;
	174	beeper->input->id.vendor = 0x001f;
	175	beeper->input->id.product = 0x0001;
	176	beeper->input->id.version = 0x0100;
	177
48a55d7d DT	178	input_set_capability(beeper->input, EV_SND, SND_TONE);
48a55d7d DT	179	input_set_capability(beeper->input, EV_SND, SND_BELL);
e22739d0 LPC	180
e22739d0 LPC	181	beeper->input->event = pwm_beeper_event;
f49cf3b8	182	beeper->input->close = pwm_beeper_close;
e22739d0 LPC	183
	184	input_set_drvdata(beeper->input, beeper);
	185
	186	error = input_register_device(beeper->input);
	187	if (error) {
bcf4b046 DT	188	dev_err(dev, "Failed to register input device: %d\n", error);
bcf4b046 DT	189	return error;
e22739d0 LPC	190	}
	191
	192	platform_set_drvdata(pdev, beeper);
	193
e22739d0 LPC	194	return 0;
	195	}
	196
349fe1e4	197	static int pwm_beeper_suspend(struct device *dev)
e22739d0 LPC	198	{
	199	struct pwm_beeper *beeper = dev_get_drvdata(dev);
	200
e9728f0d DT	201	/*
	202	* Spinlock is taken here is not to protect write to
	203	* beeper->suspended, but to ensure that pwm_beeper_event
	204	* does not re-submit work once flag is set.
	205	*/
5bd3ade1 DT	206	scoped_guard(spinlock_irq, &beeper->input->event_lock) {
	207	beeper->suspended = true;
	208	}
e9728f0d	209
f49cf3b8	210	pwm_beeper_stop(beeper);
e22739d0 LPC	211
	212	return 0;
	213	}
	214
349fe1e4	215	static int pwm_beeper_resume(struct device *dev)
e22739d0 LPC	216	{
	217	struct pwm_beeper *beeper = dev_get_drvdata(dev);
	218
5bd3ade1 DT	219	scoped_guard(spinlock_irq, &beeper->input->event_lock) {
	220	beeper->suspended = false;
	221	}
e9728f0d DT	222
	223	/* Let worker figure out if we should resume beeping */
	224	schedule_work(&beeper->work);
e22739d0 LPC	225
	226	return 0;
	227	}
	228
349fe1e4 JC	229	static DEFINE_SIMPLE_DEV_PM_OPS(pwm_beeper_pm_ops,
349fe1e4 JC	230	pwm_beeper_suspend, pwm_beeper_resume);
e22739d0	231
d56a289b SH	232	#ifdef CONFIG_OF
	233	static const struct of_device_id pwm_beeper_match[] = {
	234	{ .compatible = "pwm-beeper", },
	235	{ },
	236	};
544edf56	237	MODULE_DEVICE_TABLE(of, pwm_beeper_match);
d56a289b SH	238	#endif
d56a289b SH	239
e22739d0 LPC	240	static struct platform_driver pwm_beeper_driver = {
e22739d0 LPC	241	.probe = pwm_beeper_probe,
e22739d0 LPC	242	.driver = {
e22739d0 LPC	243	.name = "pwm-beeper",
349fe1e4	244	.pm = pm_sleep_ptr(&pwm_beeper_pm_ops),
d56a289b	245	.of_match_table = of_match_ptr(pwm_beeper_match),
e22739d0 LPC	246	},
e22739d0 LPC	247	};
840a746b	248	module_platform_driver(pwm_beeper_driver);
e22739d0 LPC	249
	250	MODULE_AUTHOR("Lars-Peter Clausen <lars@metafoo.de>");
	251	MODULE_DESCRIPTION("PWM beeper driver");
	252	MODULE_LICENSE("GPL");
	253	MODULE_ALIAS("platform:pwm-beeper");