linux/drivers/regulator/fixed-helper.c
Chen-Yu Tsai 4ddb16cf53
regulator: fixed-helper: Add missing "Return" kerneldoc section
kernel-doc complains about missing "Return" section for the function
regulator_register_always_on().

Add a "Return" section for it based on its behavior.

Signed-off-by: Chen-Yu Tsai <wenst@chromium.org>
Reported-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com>
Reviewed-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com>
Link: https://patch.msgid.link/20240829085131.1361701-8-wenst@chromium.org
Signed-off-by: Mark Brown <broonie@kernel.org>
2024-08-29 14:20:28 +01:00

64 lines
1.7 KiB
C

// SPDX-License-Identifier: GPL-2.0
#include <linux/slab.h>
#include <linux/string.h>
#include <linux/platform_device.h>
#include <linux/regulator/machine.h>
#include <linux/regulator/fixed.h>
struct fixed_regulator_data {
struct fixed_voltage_config cfg;
struct regulator_init_data init_data;
struct platform_device pdev;
};
static void regulator_fixed_release(struct device *dev)
{
struct fixed_regulator_data *data = container_of(dev,
struct fixed_regulator_data, pdev.dev);
kfree_const(data->cfg.supply_name);
kfree(data);
}
/**
* regulator_register_always_on - register an always-on regulator with a fixed name
* @id: platform device id
* @name: name to be used for the regulator
* @supplies: consumers for this regulator
* @num_supplies: number of consumers
* @uv: voltage in microvolts
*
* Return: Pointer to registered platform device, or %NULL if memory allocation fails.
*/
struct platform_device *regulator_register_always_on(int id, const char *name,
struct regulator_consumer_supply *supplies, int num_supplies, int uv)
{
struct fixed_regulator_data *data;
data = kzalloc(sizeof(*data), GFP_KERNEL);
if (!data)
return NULL;
data->cfg.supply_name = kstrdup_const(name, GFP_KERNEL);
if (!data->cfg.supply_name) {
kfree(data);
return NULL;
}
data->cfg.microvolts = uv;
data->cfg.enabled_at_boot = 1;
data->cfg.init_data = &data->init_data;
data->init_data.constraints.always_on = 1;
data->init_data.consumer_supplies = supplies;
data->init_data.num_consumer_supplies = num_supplies;
data->pdev.name = "reg-fixed-voltage";
data->pdev.id = id;
data->pdev.dev.platform_data = &data->cfg;
data->pdev.dev.release = regulator_fixed_release;
platform_device_register(&data->pdev);
return &data->pdev;
}