staticbool pwm_wf_valid(conststruct pwm_waveform *wf)
{ /* * For now restrict waveforms to period_length_ns <= S64_MAX to provide * some space for future extensions. One possibility is to simplify * representing waveforms with inverted polarity using negative values * somehow.
*/ if (wf->period_length_ns > S64_MAX) returnfalse;
if (wf->duty_length_ns > wf->period_length_ns) returnfalse;
/* * .duty_offset_ns is supposed to be smaller than .period_length_ns, apart * from the corner case .duty_offset_ns == 0 && .period_length_ns == 0.
*/ if (wf->duty_offset_ns && wf->duty_offset_ns >= wf->period_length_ns) returnfalse;
ret = ops->write_waveform(chip, pwm, wfhw);
trace_pwm_write_waveform(pwm, wfhw, ret);
return ret;
}
/** * pwm_round_waveform_might_sleep - Query hardware capabilities * Cannot be used in atomic context. * @pwm: PWM device * @wf: waveform to round and output parameter * * Typically a given waveform cannot be implemented exactly by hardware, e.g. * because hardware only supports coarse period resolution or no duty_offset. * This function returns the actually implemented waveform if you pass @wf to * pwm_set_waveform_might_sleep() now. * * Note however that the world doesn't stop turning when you call it, so when * doing:: * * pwm_round_waveform_might_sleep(mypwm, &wf); * pwm_set_waveform_might_sleep(mypwm, &wf, true); * * the latter might fail, e.g. because an input clock changed its rate between * these two calls and the waveform determined by * pwm_round_waveform_might_sleep() cannot be implemented any more. * * Usually all values passed in @wf are rounded down to the nearest possible * value (in the order period_length_ns, duty_length_ns and then * duty_offset_ns). Only if this isn't possible, a value might grow. See the * documentation for pwm_set_waveform_might_sleep() for a more formal * description. * * Returns: 0 on success, 1 if at least one value had to be rounded up or a * negative errno. * Context: May sleep.
*/ int pwm_round_waveform_might_sleep(struct pwm_device *pwm, struct pwm_waveform *wf)
{ struct pwm_chip *chip = pwm->chip; conststruct pwm_ops *ops = chip->ops; struct pwm_waveform wf_req = *wf; char wfhw[PWM_WFHWSIZE]; int ret_tohw, ret_fromhw;
BUG_ON(PWM_WFHWSIZE < ops->sizeof_wfhw);
if (!pwmchip_supports_waveform(chip)) return -EOPNOTSUPP;
/** * pwm_get_waveform_might_sleep - Query hardware about current configuration * Cannot be used in atomic context. * @pwm: PWM device * @wf: output parameter * * Stores the current configuration of the PWM in @wf. Note this is the * equivalent of pwm_get_state_hw() (and not pwm_get_state()) for pwm_waveform. * * Returns: 0 on success or a negative errno * Context: May sleep.
*/ int pwm_get_waveform_might_sleep(struct pwm_device *pwm, struct pwm_waveform *wf)
{ struct pwm_chip *chip = pwm->chip; conststruct pwm_ops *ops = chip->ops; char wfhw[PWM_WFHWSIZE]; int err;
BUG_ON(PWM_WFHWSIZE < ops->sizeof_wfhw);
if (!pwmchip_supports_waveform(chip) || !ops->read_waveform) return -EOPNOTSUPP;
guard(pwmchip)(chip);
if (!chip->operational) return -ENODEV;
err = __pwm_read_waveform(chip, pwm, &wfhw); if (err) return err;
/** * pwm_set_waveform_might_sleep - Apply a new waveform * Cannot be used in atomic context. * @pwm: PWM device * @wf: The waveform to apply * @exact: If true no rounding is allowed * * Typically a requested waveform cannot be implemented exactly, e.g. because * you requested .period_length_ns = 100 ns, but the hardware can only set * periods that are a multiple of 8.5 ns. With that hardware passing @exact = * true results in pwm_set_waveform_might_sleep() failing and returning -EDOM. * If @exact = false you get a period of 93.5 ns (i.e. the biggest period not * bigger than the requested value). * Note that even with @exact = true, some rounding by less than 1 ns is * possible/needed. In the above example requesting .period_length_ns = 94 and * @exact = true, you get the hardware configured with period = 93.5 ns. * * Let C be the set of possible hardware configurations for a given PWM device, * consisting of tuples (p, d, o) where p is the period length, d is the duty * length and o the duty offset. * * The following algorithm is implemented to pick the hardware setting * (p, d, o) ∈ C for a given request (p', d', o') with @exact = false:: * * p = max( { ṗ | ∃ ḋ, ȯ : (ṗ, ḋ, ȯ) ∈ C ∧ ṗ ≤ p' } ∪ { min({ ṗ | ∃ ḋ, ȯ : (ṗ, ḋ, ȯ) ∈ C }) }) * d = max( { ḋ | ∃ ȯ : (p, ḋ, ȯ) ∈ C ∧ ḋ ≤ d' } ∪ { min({ ḋ | ∃ ȯ : (p, ḋ, ȯ) ∈ C }) }) * o = max( { ȯ | (p, d, ȯ) ∈ C ∧ ȯ ≤ o' } ∪ { min({ ȯ | (p, d, ȯ) ∈ C }) }) * * In words: The chosen period length is the maximal possible period length not * bigger than the requested period length and if that doesn't exist, the * minimal period length. The chosen duty length is the maximal possible duty * length that is compatible with the chosen period length and isn't bigger than * the requested duty length. Again if such a value doesn't exist, the minimal * duty length compatible with the chosen period is picked. After that the duty * offset compatible with the chosen period and duty length is chosen in the * same way. * * Returns: 0 on success, -EDOM if setting failed due to the exact waveform not * being possible (if @exact), or a different negative errno on failure. * Context: May sleep.
*/ int pwm_set_waveform_might_sleep(struct pwm_device *pwm, conststruct pwm_waveform *wf, bool exact)
{ struct pwm_chip *chip = pwm->chip; int err;
might_sleep();
guard(pwmchip)(chip);
if (!chip->operational) return -ENODEV;
if (IS_ENABLED(CONFIG_PWM_DEBUG) && chip->atomic) { /* * Catch any drivers that have been marked as atomic but * that will sleep anyway.
*/
non_block_start();
err = __pwm_set_waveform(pwm, wf, exact);
non_block_end();
} else {
err = __pwm_set_waveform(pwm, wf, exact);
}
/* * map err == 1 to -EDOM for exact requests and 0 for !exact ones. Also * make sure that -EDOM is only returned in exactly that case. Note that * __pwm_set_waveform() should never return -EDOM which justifies the * unlikely().
*/ if (unlikely(err == -EDOM))
err = -EINVAL; elseif (exact && err == 1)
err = -EDOM; elseif (err == 1)
err = 0;
/* No reasonable diagnosis possible without .get_state() */ if (!chip->ops->get_state) return;
/* * *state was just applied. Read out the hardware state and do some * checks.
*/
err = chip->ops->get_state(chip, pwm, &s1);
trace_pwm_get(pwm, &s1, err); if (err) /* If that failed there isn't much to debug */ return;
/* * The lowlevel driver either ignored .polarity (which is a bug) or as * best effort inverted .polarity and fixed .duty_cycle respectively. * Undo this inversion and fixup for further tests.
*/ if (s1.enabled && s1.polarity != state->polarity) {
s2.polarity = state->polarity;
s2.duty_cycle = s1.period - s1.duty_cycle;
s2.period = s1.period;
s2.enabled = s1.enabled;
} else {
s2 = s1;
}
if (state->enabled && s2.enabled &&
last->polarity == state->polarity &&
last->period > s2.period &&
last->period <= state->period)
dev_warn(pwmchip_parent(chip), ".apply didn't pick the best available period (requested: %llu, applied: %llu, possible: %llu)\n",
state->period, s2.period, last->period);
/* * Rounding period up is fine only if duty_cycle is 0 then, because a * flat line doesn't have a characteristic period.
*/ if (state->enabled && s2.enabled && state->period < s2.period && s2.duty_cycle)
dev_warn(pwmchip_parent(chip), ".apply is supposed to round down period (requested: %llu, applied: %llu)\n",
state->period, s2.period);
if (state->enabled &&
last->polarity == state->polarity &&
last->period == s2.period &&
last->duty_cycle > s2.duty_cycle &&
last->duty_cycle <= state->duty_cycle)
dev_warn(pwmchip_parent(chip), ".apply didn't pick the best available duty cycle (requested: %llu/%llu, applied: %llu/%llu, possible: %llu/%llu)\n",
state->duty_cycle, state->period,
s2.duty_cycle, s2.period,
last->duty_cycle, last->period);
if (state->enabled && s2.enabled && state->duty_cycle < s2.duty_cycle)
dev_warn(pwmchip_parent(chip), ".apply is supposed to round down duty_cycle (requested: %llu/%llu, applied: %llu/%llu)\n",
state->duty_cycle, state->period,
s2.duty_cycle, s2.period);
if (!state->enabled && s2.enabled && s2.duty_cycle > 0)
dev_warn(pwmchip_parent(chip), "requested disabled, but yielded enabled with duty > 0\n");
/* reapply the state that the driver reported being configured. */
err = chip->ops->apply(chip, pwm, &s1);
trace_pwm_apply(pwm, &s1, err); if (err) {
*last = s1;
dev_err(pwmchip_parent(chip), "failed to reapply current setting\n"); return;
}
*last = (struct pwm_state){ 0 };
err = chip->ops->get_state(chip, pwm, last);
trace_pwm_get(pwm, last, err); if (err) return;
/* reapplication of the current state should give an exact match */ if (s1.enabled != last->enabled ||
s1.polarity != last->polarity ||
(s1.enabled && s1.period != last->period) ||
(s1.enabled && s1.duty_cycle != last->duty_cycle)) {
dev_err(pwmchip_parent(chip), ".apply is not idempotent (ena=%d pol=%d %llu/%llu) -> (ena=%d pol=%d %llu/%llu)\n",
s1.enabled, s1.polarity, s1.duty_cycle, s1.period,
last->enabled, last->polarity, last->duty_cycle,
last->period);
}
}
staticbool pwm_state_valid(conststruct pwm_state *state)
{ /* * For a disabled state all other state description is irrelevant and * and supposed to be ignored. So also ignore any strange values and * consider the state ok.
*/ if (!state->enabled) returntrue;
if (!state->period) returnfalse;
if (state->duty_cycle > state->period) returnfalse;
if (!pwm_state_valid(state)) { /* * Allow to transition from one invalid state to another. * This ensures that you can e.g. change the polarity while * the period is zero. (This happens on stm32 when the hardware * is in its poweron default state.) This greatly simplifies * working with the sysfs API where you can only change one * parameter at a time.
*/ if (!pwm_state_valid(&pwm->state)) {
pwm->state = *state; return 0;
}
if (pwmchip_supports_waveform(chip)) { struct pwm_waveform wf; char wfhw[PWM_WFHWSIZE];
BUG_ON(PWM_WFHWSIZE < ops->sizeof_wfhw);
pwm_state2wf(state, &wf);
/* * The rounding is wrong here for states with inverted polarity. * While .apply() rounds down duty_cycle (which represents the * time from the start of the period to the inner edge), * .round_waveform_tohw() rounds down the time the PWM is high. * Can be fixed if the need arises, until reported otherwise * let's assume that consumers don't care.
*/
err = __pwm_round_waveform_tohw(chip, pwm, &wf, &wfhw); if (err) { if (err > 0) /* * This signals an invalid request, typically * the requested period (or duty_offset) is * smaller than possible with the hardware.
*/ return -EINVAL;
return err;
}
if (IS_ENABLED(CONFIG_PWM_DEBUG)) { struct pwm_waveform wf_rounded;
err = __pwm_round_waveform_fromhw(chip, pwm, &wfhw, &wf_rounded); if (err) return err;
if (!pwm_check_rounding(&wf, &wf_rounded))
dev_err(&chip->dev, "Wrong rounding: requested %llu/%llu [+%llu], result %llu/%llu [+%llu]\n",
wf.duty_length_ns, wf.period_length_ns, wf.duty_offset_ns,
wf_rounded.duty_length_ns, wf_rounded.period_length_ns, wf_rounded.duty_offset_ns);
}
err = __pwm_write_waveform(chip, pwm, &wfhw); if (err) return err;
/* * only do this after pwm->state was applied as some * implementations of .get_state() depend on this
*/
pwm_apply_debug(pwm, state);
}
return 0;
}
/** * pwm_apply_might_sleep() - atomically apply a new state to a PWM device * Cannot be used in atomic context. * @pwm: PWM device * @state: new state to apply * * Returns: 0 on success, or a negative errno * Context: May sleep.
*/ int pwm_apply_might_sleep(struct pwm_device *pwm, conststruct pwm_state *state)
{ int err; struct pwm_chip *chip = pwm->chip;
/* * Some lowlevel driver's implementations of .apply() make use of * mutexes, also with some drivers only returning when the new * configuration is active calling pwm_apply_might_sleep() from atomic context * is a bad idea. So make it explicit that calling this function might * sleep.
*/
might_sleep();
guard(pwmchip)(chip);
if (!chip->operational) return -ENODEV;
if (IS_ENABLED(CONFIG_PWM_DEBUG) && chip->atomic) { /* * Catch any drivers that have been marked as atomic but * that will sleep anyway.
*/
non_block_start();
err = __pwm_apply(pwm, state);
non_block_end();
} else {
err = __pwm_apply(pwm, state);
}
/** * pwm_apply_atomic() - apply a new state to a PWM device from atomic context * Not all PWM devices support this function, check with pwm_might_sleep(). * @pwm: PWM device * @state: new state to apply * * Returns: 0 on success, or a negative errno * Context: Any
*/ int pwm_apply_atomic(struct pwm_device *pwm, conststruct pwm_state *state)
{ struct pwm_chip *chip = pwm->chip;
WARN_ONCE(!chip->atomic, "sleeping PWM driver used in atomic context\n");
/** * pwm_get_state_hw() - get the current PWM state from hardware * @pwm: PWM device * @state: state to fill with the current PWM state * * Similar to pwm_get_state() but reads the current PWM state from hardware * instead of the requested state. * * Returns: 0 on success or a negative error code on failure. * Context: May sleep.
*/ int pwm_get_state_hw(struct pwm_device *pwm, struct pwm_state *state)
{ struct pwm_chip *chip = pwm->chip; conststruct pwm_ops *ops = chip->ops; int ret = -EOPNOTSUPP;
might_sleep();
guard(pwmchip)(chip);
if (!chip->operational) return -ENODEV;
if (pwmchip_supports_waveform(chip) && ops->read_waveform) { char wfhw[PWM_WFHWSIZE]; struct pwm_waveform wf;
BUG_ON(PWM_WFHWSIZE < ops->sizeof_wfhw);
ret = __pwm_read_waveform(chip, pwm, &wfhw); if (ret) return ret;
ret = __pwm_round_waveform_fromhw(chip, pwm, &wfhw, &wf); if (ret) return ret;
/** * pwm_adjust_config() - adjust the current PWM config to the PWM arguments * @pwm: PWM device * * This function will adjust the PWM config to the PWM arguments provided * by the DT or PWM lookup table. This is particularly useful to adapt * the bootloader config to the Linux one. * * Returns: 0 on success or a negative error code on failure. * Context: May sleep.
*/ int pwm_adjust_config(struct pwm_device *pwm)
{ struct pwm_state state; struct pwm_args pargs;
/* * If the current period is zero it means that either the PWM driver * does not support initial state retrieval or the PWM has not yet * been configured. * * In either case, we setup the new period and polarity, and assign a * duty cycle of 0.
*/ if (!state.period) {
state.duty_cycle = 0;
state.period = pargs.period;
state.polarity = pargs.polarity;
return pwm_apply_might_sleep(pwm, &state);
}
/* * Adjust the PWM duty cycle/period based on the period value provided * in PWM args.
*/ if (pargs.period != state.period) {
u64 dutycycle = (u64)state.duty_cycle * pargs.period;
/* * If the polarity changed, we should also change the duty cycle.
*/ if (pargs.polarity != state.polarity) {
state.polarity = pargs.polarity;
state.duty_cycle = state.period - state.duty_cycle;
}
/** * pwm_capture() - capture and report a PWM signal * @pwm: PWM device * @result: structure to fill with capture result * @timeout: time to wait, in milliseconds, before giving up on capture * * Returns: 0 on success or a negative error code on failure.
*/ staticint pwm_capture(struct pwm_device *pwm, struct pwm_capture *result, unsignedlong timeout)
{ struct pwm_chip *chip = pwm->chip; conststruct pwm_ops *ops = chip->ops;
if (!ops->capture) return -ENOSYS;
/* * Holding the pwm_lock is probably not needed. If you use pwm_capture() * and you're interested to speed it up, please convince yourself it's * really not needed, test and then suggest a patch on the mailing list.
*/
guard(mutex)(&pwm_lock);
if (test_bit(PWMF_REQUESTED, &pwm->flags)) return -EBUSY;
/* * This function is called while holding pwm_lock. As .operational only * changes while holding this lock, checking it here without holding the * chip lock is fine.
*/ if (!chip->operational) return -ENODEV;
if (!try_module_get(chip->owner)) return -ENODEV;
if (!get_device(&chip->dev)) {
err = -ENODEV; goto err_get_device;
}
if (ops->request) {
err = ops->request(chip, pwm); if (err) {
put_device(&chip->dev);
err_get_device:
module_put(chip->owner); return err;
}
}
if (ops->read_waveform || ops->get_state) { /* * Zero-initialize state because most drivers are unaware of * .usage_power. The other members of state are supposed to be * set by lowlevel drivers. We still initialize the whole * structure for simplicity even though this might paper over * faulty implementations of .get_state().
*/ struct pwm_state state = { 0, };
err = pwm_get_state_hw(pwm, &state); if (!err)
pwm->state = state;
if (IS_ENABLED(CONFIG_PWM_DEBUG))
pwm->last = pwm->state;
}
/** * pwm_request_from_chip() - request a PWM device relative to a PWM chip * @chip: PWM chip * @index: per-chip index of the PWM to request * @label: a literal description string of this PWM * * Returns: A pointer to the PWM device at the given index of the given PWM * chip. A negative error code is returned if the index is not valid for the * specified PWM chip or if the PWM device cannot be requested.
*/ staticstruct pwm_device *pwm_request_from_chip(struct pwm_chip *chip, unsignedint index, constchar *label)
{ struct pwm_device *pwm; int err;
if (!chip || index >= chip->npwm) return ERR_PTR(-EINVAL);
guard(mutex)(&pwm_lock);
pwm = &chip->pwms[index];
err = pwm_device_request(pwm, label); if (err < 0) return ERR_PTR(err);
/* * This callback is used for PXA PWM chips that only have a single PWM line. * For such chips you could argue that passing the line number (i.e. the first * parameter in the common case) is useless as it's always zero. So compared to * the default xlate function of_pwm_xlate_with_flags() the first parameter is * the default period and the second are flags. * * Note that if #pwm-cells = <3>, the semantic is the same as for * of_pwm_xlate_with_flags() to allow converting the affected driver to * #pwm-cells = <3> without breaking the legacy binding. * * Don't use for new drivers.
*/ struct pwm_device *
of_pwm_single_xlate(struct pwm_chip *chip, conststruct of_phandle_args *args)
{ struct pwm_device *pwm;
if (args->args_count >= 3) return of_pwm_xlate_with_flags(chip, args);
pwm = pwm_request_from_chip(chip, 0, NULL); if (IS_ERR(pwm)) return pwm;
if (args->args_count > 0)
pwm->args.period = args->args[0];
staticint pwm_class_apply_state(struct pwm_export *export, struct pwm_device *pwm, struct pwm_state *state)
{ int ret = pwm_apply_might_sleep(pwm, state);
/* release lock taken in pwm_class_get_state */
mutex_unlock(&export->lock);
return ret;
}
staticint pwm_class_resume_npwm(struct device *pwmchip_dev, unsignedint npwm)
{ struct pwm_chip *chip = pwmchip_from_dev(pwmchip_dev); unsignedint i; int ret = 0;
for (i = 0; i < npwm; i++) { struct pwm_device *pwm = &chip->pwms[i]; struct pwm_state state; struct pwm_export *export;
export = pwm_class_get_state(pwmchip_dev, pwm, &state); if (!export) continue;
/* If pwmchip was not enabled before suspend, do nothing. */ if (!export->suspend.enabled) { /* release lock taken in pwm_class_get_state */
mutex_unlock(&export->lock); continue;
}
state.enabled = export->suspend.enabled;
ret = pwm_class_apply_state(export, pwm, &state); if (ret < 0) break;
}
return ret;
}
staticint pwm_class_suspend(struct device *pwmchip_dev)
{ struct pwm_chip *chip = pwmchip_from_dev(pwmchip_dev); unsignedint i; int ret = 0;
for (i = 0; i < chip->npwm; i++) { struct pwm_device *pwm = &chip->pwms[i]; struct pwm_state state; struct pwm_export *export;
export = pwm_class_get_state(pwmchip_dev, pwm, &state); if (!export) continue;
/* * If pwmchip was not enabled before suspend, save * state for resume time and do nothing else.
*/
export->suspend = state; if (!state.enabled) { /* release lock taken in pwm_class_get_state */
mutex_unlock(&export->lock); continue;
}
state.enabled = false;
ret = pwm_class_apply_state(export, pwm, &state); if (ret < 0) { /* * roll back the PWM devices that were disabled by * this suspend function.
*/
pwm_class_resume_npwm(pwmchip_dev, i); break;
}
}
if (!dev) { /* * No device for the PWM consumer has been provided. It may * impact the PM sequence ordering: the PWM supplier may get * suspended before the consumer.
*/
dev_warn(pwmchip_parent(pwm->chip), "No consumer device specified to create a link to\n"); return NULL;
}
dl = device_link_add(dev, pwmchip_parent(pwm->chip), DL_FLAG_AUTOREMOVE_CONSUMER); if (!dl) {
dev_err(dev, "failed to create device link to %s\n",
dev_name(pwmchip_parent(pwm->chip))); return ERR_PTR(-EINVAL);
}
/** * of_pwm_get() - request a PWM via the PWM framework * @dev: device for PWM consumer * @np: device node to get the PWM from * @con_id: consumer name * * Returns the PWM device parsed from the phandle and index specified in the * "pwms" property of a device tree node or a negative error-code on failure. * Values parsed from the device tree are stored in the returned PWM device * object. * * If con_id is NULL, the first PWM device listed in the "pwms" property will * be requested. Otherwise the "pwm-names" property is used to do a reverse * lookup of the PWM index. This also means that the "pwm-names" property * becomes mandatory for devices that look up the PWM device via the con_id * parameter. * * Returns: A pointer to the requested PWM device or an ERR_PTR()-encoded * error code on failure.
*/ staticstruct pwm_device *of_pwm_get(struct device *dev, struct device_node *np, constchar *con_id)
{ struct pwm_device *pwm = NULL; struct of_phandle_args args; struct device_link *dl; struct pwm_chip *chip; int index = 0; int err;
if (con_id) {
index = of_property_match_string(np, "pwm-names", con_id); if (index < 0) return ERR_PTR(index);
}
/* * If a consumer name was not given, try to look it up from the * "pwm-names" property if it exists. Otherwise use the name of * the user device node.
*/ if (!con_id) {
err = of_property_read_string_index(np, "pwm-names", index,
&con_id); if (err < 0)
con_id = np->name;
}
pwm->label = con_id;
put:
of_node_put(args.np);
return pwm;
}
/** * acpi_pwm_get() - request a PWM via parsing "pwms" property in ACPI * @fwnode: firmware node to get the "pwms" property from * * Returns the PWM device parsed from the fwnode and index specified in the * "pwms" property or a negative error-code on failure. * Values parsed from the device tree are stored in the returned PWM device * object. * * This is analogous to of_pwm_get() except con_id is not yet supported. * ACPI entries must look like * Package () {"pwms", Package () * { <PWM device reference>, <PWM index>, <PWM period> [, <PWM flags>]}} * * Returns: A pointer to the requested PWM device or an ERR_PTR()-encoded * error code on failure.
*/ staticstruct pwm_device *acpi_pwm_get(conststruct fwnode_handle *fwnode)
{ struct pwm_device *pwm; struct fwnode_reference_args args; struct pwm_chip *chip; int ret;
memset(&args, 0, sizeof(args));
ret = __acpi_node_get_property_reference(fwnode, "pwms", 0, 3, &args); if (ret < 0) return ERR_PTR(ret);
if (args.nargs < 2) return ERR_PTR(-EPROTO);
chip = fwnode_to_pwmchip(args.fwnode); if (IS_ERR(chip)) return ERR_CAST(chip);
pwm = pwm_request_from_chip(chip, args.args[0], NULL); if (IS_ERR(pwm)) return pwm;
/** * pwm_get() - look up and request a PWM device * @dev: device for PWM consumer * @con_id: consumer name * * Lookup is first attempted using DT. If the device was not instantiated from * a device tree, a PWM chip and a relative index is looked up via a table * supplied by board setup code (see pwm_add_table()). * * Once a PWM chip has been found the specified PWM device will be requested * and is ready to be used. * * Returns: A pointer to the requested PWM device or an ERR_PTR()-encoded * error code on failure.
*/ struct pwm_device *pwm_get(struct device *dev, constchar *con_id)
{ conststruct fwnode_handle *fwnode = dev ? dev_fwnode(dev) : NULL; constchar *dev_id = dev ? dev_name(dev) : NULL; struct pwm_device *pwm; struct pwm_chip *chip; struct device_link *dl; unsignedint best = 0; struct pwm_lookup *p, *chosen = NULL; unsignedint match; int err;
/* look up via DT first */ if (is_of_node(fwnode)) return of_pwm_get(dev, to_of_node(fwnode), con_id);
/* then lookup via ACPI */ if (is_acpi_node(fwnode)) {
pwm = acpi_pwm_get(fwnode); if (!IS_ERR(pwm) || PTR_ERR(pwm) != -ENOENT) return pwm;
}
/* * We look up the provider in the static table typically provided by * board setup code. We first try to lookup the consumer device by * name. If the consumer device was passed in as NULL or if no match * was found, we try to find the consumer by directly looking it up * by name. * * If a match is found, the provider PWM chip is looked up by name * and a PWM device is requested using the PWM device per-chip index. * * The lookup algorithm was shamelessly taken from the clock * framework: * * We do slightly fuzzy matching here: * An entry with a NULL ID is assumed to be a wildcard. * If an entry has a device ID, it must match * If an entry has a connection ID, it must match * Then we take the most specific entry - with the following order * of precedence: dev+con > dev only > con only.
*/
scoped_guard(mutex, &pwm_lookup_lock)
list_for_each_entry(p, &pwm_lookup_list, list) {
match = 0;
if (p->dev_id) { if (!dev_id || strcmp(p->dev_id, dev_id)) continue;
match += 2;
}
if (p->con_id) { if (!con_id || strcmp(p->con_id, con_id)) continue;
match += 1;
}
if (match > best) {
chosen = p;
if (match != 3)
best = match; else break;
}
}
if (!chosen) return ERR_PTR(-ENODEV);
chip = pwmchip_find_by_name(chosen->provider);
/* * If the lookup entry specifies a module, load the module and retry * the PWM chip lookup. This can be used to work around driver load * ordering issues if driver's can't be made to properly support the * deferred probe mechanism.
*/ if (!chip && chosen->module) {
err = request_module(chosen->module); if (err == 0)
chip = pwmchip_find_by_name(chosen->provider);
}
/* * Trigger a warning if a consumer called pwm_put() twice. * If the chip isn't operational, PWMF_REQUESTED was already cleared in * pwmchip_remove(). So don't warn in this case.
*/ if (chip->operational && !test_and_clear_bit(PWMF_REQUESTED, &pwm->flags)) {
pr_warn("PWM device already freed\n"); return;
}
if (chip->operational && chip->ops->free)
pwm->chip->ops->free(pwm->chip, pwm);
/** * devm_pwm_get() - resource managed pwm_get() * @dev: device for PWM consumer * @con_id: consumer name * * This function performs like pwm_get() but the acquired PWM device will * automatically be released on driver detach. * * Returns: A pointer to the requested PWM device or an ERR_PTR()-encoded * error code on failure.
*/ struct pwm_device *devm_pwm_get(struct device *dev, constchar *con_id)
{ struct pwm_device *pwm; int ret;
pwm = pwm_get(dev, con_id); if (IS_ERR(pwm)) return pwm;
ret = devm_add_action_or_reset(dev, devm_pwm_release, pwm); if (ret) return ERR_PTR(ret);
return pwm;
}
EXPORT_SYMBOL_GPL(devm_pwm_get);
/** * devm_fwnode_pwm_get() - request a resource managed PWM from firmware node * @dev: device for PWM consumer * @fwnode: firmware node to get the PWM from * @con_id: consumer name * * Returns the PWM device parsed from the firmware node. See of_pwm_get() and * acpi_pwm_get() for a detailed description. * * Returns: A pointer to the requested PWM device or an ERR_PTR()-encoded * error code on failure.
*/ struct pwm_device *devm_fwnode_pwm_get(struct device *dev, struct fwnode_handle *fwnode, constchar *con_id)
{ struct pwm_device *pwm = ERR_PTR(-ENODEV); int ret;
if (is_of_node(fwnode))
pwm = of_pwm_get(dev, to_of_node(fwnode), con_id); elseif (is_acpi_node(fwnode))
pwm = acpi_pwm_get(fwnode); if (IS_ERR(pwm)) return pwm;
ret = devm_add_action_or_reset(dev, devm_pwm_release, pwm); if (ret) return ERR_PTR(ret);
pwm = pwm_cdev_get_requested_pwm(cdata, cwf.hwpwm); if (IS_ERR(pwm)) return PTR_ERR(pwm);
ret = pwm_set_waveform_might_sleep(pwm, &wf,
cmd == PWM_IOCTL_SETEXACTWF);
/* * If userspace cares about rounding deviations it has * to check the values anyhow, so simplify handling for * them and don't signal uprounding. This matches the * behaviour of PWM_IOCTL_ROUNDWF which also returns 0 * in that case.
*/ if (ret == 1)
ret = 0;
/** * __pwmchip_add() - register a new PWM chip * @chip: the PWM chip to add * @owner: reference to the module providing the chip. * * Register a new PWM chip. @owner is supposed to be THIS_MODULE, use the * pwmchip_add wrapper to do this right. * * Returns: 0 on success or a negative error code on failure.
*/ int __pwmchip_add(struct pwm_chip *chip, struct module *owner)
{ int ret;
if (!chip || !pwmchip_parent(chip) || !chip->ops || !chip->npwm) return -EINVAL;
/* * a struct pwm_chip must be allocated using (devm_)pwmchip_alloc, * otherwise the embedded struct device might disappear too early * resulting in memory corruption. * Catch drivers that were not converted appropriately.
*/ if (!chip->uses_pwmchip_alloc) return -EINVAL;
if (!pwm_ops_check(chip)) return -EINVAL;
chip->owner = owner;
if (chip->atomic)
spin_lock_init(&chip->atomic_lock); else
mutex_init(&chip->nonatomic_lock);
guard(mutex)(&pwm_lock);
ret = idr_alloc(&pwm_chips, chip, 0, 0, GFP_KERNEL); if (ret < 0) return ret;
if (chip->ops->write_waveform) { if (chip->id < PWM_MINOR_COUNT)
chip->dev.devt = MKDEV(MAJOR(pwm_devt), chip->id); else
dev_warn(&chip->dev, "chip id too high to create a chardev\n");
}
Die Informationen auf dieser Webseite wurden
nach bestem Wissen sorgfältig zusammengestellt. Es wird jedoch weder Vollständigkeit, noch Richtigkeit,
noch Qualität der bereit gestellten Informationen zugesichert.
Bemerkung:
Die farbliche Syntaxdarstellung und die Messung sind noch experimentell.