mirror of
https://github.com/u-boot/u-boot.git
synced 2025-04-19 11:24:42 +00:00
8877bc51a8
Mikhail Kshevetskiy <mikhail.kshevetskiy@iopsys.eu> says: v2 changes: * Drop sw_blink_state structure, move its necessary fields to led_uc_plat structure. * Add cyclic_info pointer to led_uc_plat structure. This simplify code a lot. * Remove cyclic function search logic. Not needed anymore. * Fix blinking period. It was twice large. * Other cleanups. v3 changes: * Adapt code to recent cyclic function changes * Move software blinking functions to separate file * Other small changes v4 changes: * Refactoring of led_set_period() function v5 changes * Fix compilation if CONFIG_LED_BLINK is not defined v6 changes: * Enable LEDST_BLINK state unconditionally. * Function led_set_period() becomes available when CONFIG_LED_BLINK is disabled. This makes led code simpler. * Software blinking requires about 100 bytes of data for a led. It's not a good idea to allocate so much memory for each supported led. Change the code to allocate blinking data only for required leds.
144 lines
3.3 KiB
C
144 lines
3.3 KiB
C
/* SPDX-License-Identifier: GPL-2.0+ */
|
|
/*
|
|
* Copyright (c) 2015 Google, Inc
|
|
* Written by Simon Glass <sjg@chromium.org>
|
|
*/
|
|
|
|
#ifndef __LED_H
|
|
#define __LED_H
|
|
|
|
#include <stdbool.h>
|
|
#include <cyclic.h>
|
|
|
|
struct udevice;
|
|
|
|
enum led_state_t {
|
|
LEDST_OFF = 0,
|
|
LEDST_ON = 1,
|
|
LEDST_TOGGLE,
|
|
LEDST_BLINK,
|
|
|
|
LEDST_COUNT,
|
|
};
|
|
|
|
enum led_sw_blink_state_t {
|
|
LED_SW_BLINK_ST_DISABLED,
|
|
LED_SW_BLINK_ST_NOT_READY,
|
|
LED_SW_BLINK_ST_OFF,
|
|
LED_SW_BLINK_ST_ON,
|
|
};
|
|
|
|
struct led_sw_blink {
|
|
enum led_sw_blink_state_t state;
|
|
struct udevice *dev;
|
|
struct cyclic_info cyclic;
|
|
const char cyclic_name[0];
|
|
};
|
|
|
|
/**
|
|
* struct led_uc_plat - Platform data the uclass stores about each device
|
|
*
|
|
* @label: LED label
|
|
* @default_state: LED default state
|
|
*/
|
|
struct led_uc_plat {
|
|
const char *label;
|
|
enum led_state_t default_state;
|
|
#ifdef CONFIG_LED_SW_BLINK
|
|
struct led_sw_blink *sw_blink;
|
|
#endif
|
|
};
|
|
|
|
/**
|
|
* struct led_uc_priv - Private data the uclass stores about each device
|
|
*
|
|
* @period_ms: Flash period in milliseconds
|
|
*/
|
|
struct led_uc_priv {
|
|
int period_ms;
|
|
};
|
|
|
|
struct led_ops {
|
|
/**
|
|
* set_state() - set the state of an LED
|
|
*
|
|
* @dev: LED device to change
|
|
* @state: LED state to set
|
|
* @return 0 if OK, -ve on error
|
|
*/
|
|
int (*set_state)(struct udevice *dev, enum led_state_t state);
|
|
|
|
/**
|
|
* led_get_state() - get the state of an LED
|
|
*
|
|
* @dev: LED device to change
|
|
* @return LED state led_state_t, or -ve on error
|
|
*/
|
|
enum led_state_t (*get_state)(struct udevice *dev);
|
|
|
|
#ifdef CONFIG_LED_BLINK
|
|
/**
|
|
* led_set_period() - set the blink period of an LED
|
|
*
|
|
* Thie records the period if supported, or returns -ENOSYS if not.
|
|
* To start the LED blinking, use set_state().
|
|
*
|
|
* @dev: LED device to change
|
|
* @period_ms: LED blink period in milliseconds
|
|
* @return 0 if OK, -ve on error
|
|
*/
|
|
int (*set_period)(struct udevice *dev, int period_ms);
|
|
#endif
|
|
};
|
|
|
|
#define led_get_ops(dev) ((struct led_ops *)(dev)->driver->ops)
|
|
|
|
/**
|
|
* led_get_by_label() - Find an LED device by label
|
|
*
|
|
* @label: LED label to look up
|
|
* @devp: Returns the associated device, if found
|
|
* Return: 0 if found, -ENODEV if not found, other -ve on error
|
|
*/
|
|
int led_get_by_label(const char *label, struct udevice **devp);
|
|
|
|
/**
|
|
* led_set_state() - set the state of an LED
|
|
*
|
|
* @dev: LED device to change
|
|
* @state: LED state to set
|
|
* Return: 0 if OK, -ve on error
|
|
*/
|
|
int led_set_state(struct udevice *dev, enum led_state_t state);
|
|
|
|
/**
|
|
* led_get_state() - get the state of an LED
|
|
*
|
|
* @dev: LED device to change
|
|
* Return: LED state led_state_t, or -ve on error
|
|
*/
|
|
enum led_state_t led_get_state(struct udevice *dev);
|
|
|
|
/**
|
|
* led_set_period() - set the blink period of an LED
|
|
*
|
|
* @dev: LED device to change
|
|
* @period_ms: LED blink period in milliseconds
|
|
* Return: 0 if OK, -ve on error
|
|
*/
|
|
int led_set_period(struct udevice *dev, int period_ms);
|
|
|
|
/**
|
|
* led_bind_generic() - bind children of parent to given driver
|
|
*
|
|
* @parent: Top-level LED device
|
|
* @driver_name: Driver for handling individual child nodes
|
|
*/
|
|
int led_bind_generic(struct udevice *parent, const char *driver_name);
|
|
|
|
/* Internal functions for software blinking. Do not use them in your code */
|
|
int led_sw_set_period(struct udevice *dev, int period_ms);
|
|
bool led_sw_is_blinking(struct udevice *dev);
|
|
bool led_sw_on_state_change(struct udevice *dev, enum led_state_t state);
|
|
|
|
#endif
|