cregit-Linux how code gets into the kernel

Release 4.14 include/linux/leds.h

Directory: include/linux
/*
 * Driver model for leds and led triggers
 *
 * Copyright (C) 2005 John Lenz <lenz@cs.wisc.edu>
 * Copyright (C) 2005 Richard Purdie <rpurdie@openedhand.com>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation.
 *
 */
#ifndef __LINUX_LEDS_H_INCLUDED

#define __LINUX_LEDS_H_INCLUDED

#include <linux/device.h>
#include <linux/kernfs.h>
#include <linux/list.h>
#include <linux/mutex.h>
#include <linux/rwsem.h>
#include <linux/spinlock.h>
#include <linux/timer.h>
#include <linux/workqueue.h>

struct device;
/*
 * LED Core
 */


enum led_brightness {
	
LED_OFF		= 0,
	
LED_ON		= 1,
	
LED_HALF	= 127,
	
LED_FULL	= 255,
};


struct led_classdev {
	
const char		*name;
	
enum led_brightness	 brightness;
	
enum led_brightness	 max_brightness;
	
int			 flags;

	/* Lower 16 bits reflect status */

#define LED_SUSPENDED		(1 << 0)

#define LED_UNREGISTERING	(1 << 1)
	/* Upper 16 bits reflect control information */

#define LED_CORE_SUSPENDRESUME	(1 << 16)

#define LED_SYSFS_DISABLE	(1 << 17)

#define LED_DEV_CAP_FLASH	(1 << 18)

#define LED_HW_PLUGGABLE	(1 << 19)

#define LED_PANIC_INDICATOR	(1 << 20)

#define LED_BRIGHT_HW_CHANGED	(1 << 21)

#define LED_RETAIN_AT_SHUTDOWN	(1 << 22)

	/* set_brightness_work / blink_timer flags, atomic, private. */
	
unsigned long		work_flags;


#define LED_BLINK_SW			0

#define LED_BLINK_ONESHOT		1

#define LED_BLINK_ONESHOT_STOP		2

#define LED_BLINK_INVERT		3

#define LED_BLINK_BRIGHTNESS_CHANGE 	4

#define LED_BLINK_DISABLE		5

	/* Set LED brightness level
         * Must not sleep. Use brightness_set_blocking for drivers
         * that can sleep while setting brightness.
         */
	
void		(*brightness_set)(struct led_classdev *led_cdev,
					  enum led_brightness brightness);
	/*
         * Set LED brightness level immediately - it can block the caller for
         * the time required for accessing a LED device register.
         */
	
int (*brightness_set_blocking)(struct led_classdev *led_cdev,
				       enum led_brightness brightness);
	/* Get LED brightness level */
	
enum led_brightness (*brightness_get)(struct led_classdev *led_cdev);

	/*
         * Activate hardware accelerated blink, delays are in milliseconds
         * and if both are zero then a sensible default should be chosen.
         * The call should adjust the timings in that case and if it can't
         * match the values specified exactly.
         * Deactivate blinking again when the brightness is set to LED_OFF
         * via the brightness_set() callback.
         */
	
int		(*blink_set)(struct led_classdev *led_cdev,
				     unsigned long *delay_on,
				     unsigned long *delay_off);

	
struct device		*dev;
	
const struct attribute_group	**groups;

	
struct list_head	 node;			/* LED Device list */
	
const char		*default_trigger;	/* Trigger to use */

	

unsigned long		 blink_delay_on, blink_delay_off;
	
struct timer_list	 blink_timer;
	
int			 blink_brightness;
	
int			 new_blink_brightness;
	
void			(*flash_resume)(struct led_classdev *led_cdev);

	
struct work_struct	set_brightness_work;
	
int			delayed_set_value;

#ifdef CONFIG_LEDS_TRIGGERS
	/* Protects the trigger data below */
	
struct rw_semaphore	 trigger_lock;

	
struct led_trigger	*trigger;
	
struct list_head	 trig_list;
	
void			*trigger_data;
	/* true if activated - deactivate routine uses it to do cleanup */
	
bool			activated;
#endif

#ifdef CONFIG_LEDS_BRIGHTNESS_HW_CHANGED
	
int			 brightness_hw_changed;
	
struct kernfs_node	*brightness_hw_changed_kn;
#endif

	/* Ensures consistent access to the LED Flash Class device */
	
struct mutex		led_access;
};

extern int of_led_classdev_register(struct device *parent,
				    struct device_node *np,
				    struct led_classdev *led_cdev);

#define led_classdev_register(parent, led_cdev)				\
	of_led_classdev_register(parent, NULL, led_cdev)
extern int devm_of_led_classdev_register(struct device *parent,
					 struct device_node *np,
					 struct led_classdev *led_cdev);

#define devm_led_classdev_register(parent, led_cdev)			\
	devm_of_led_classdev_register(parent, NULL, led_cdev)
extern void led_classdev_unregister(struct led_classdev *led_cdev);
extern void devm_led_classdev_unregister(struct device *parent,
					 struct led_classdev *led_cdev);
extern void led_classdev_suspend(struct led_classdev *led_cdev);
extern void led_classdev_resume(struct led_classdev *led_cdev);

/**
 * led_blink_set - set blinking with software fallback
 * @led_cdev: the LED to start blinking
 * @delay_on: the time it should be on (in ms)
 * @delay_off: the time it should ble off (in ms)
 *
 * This function makes the LED blink, attempting to use the
 * hardware acceleration if possible, but falling back to
 * software blinking if there is no hardware blinking or if
 * the LED refuses the passed values.
 *
 * Note that if software blinking is active, simply calling
 * led_cdev->brightness_set() will not stop the blinking,
 * use led_classdev_brightness_set() instead.
 */
extern void led_blink_set(struct led_classdev *led_cdev,
			  unsigned long *delay_on,
			  unsigned long *delay_off);
/**
 * led_blink_set_oneshot - do a oneshot software blink
 * @led_cdev: the LED to start blinking
 * @delay_on: the time it should be on (in ms)
 * @delay_off: the time it should ble off (in ms)
 * @invert: blink off, then on, leaving the led on
 *
 * This function makes the LED blink one time for delay_on +
 * delay_off time, ignoring the request if another one-shot
 * blink is already in progress.
 *
 * If invert is set, led blinks for delay_off first, then for
 * delay_on and leave the led on after the on-off cycle.
 */
extern void led_blink_set_oneshot(struct led_classdev *led_cdev,
				  unsigned long *delay_on,
				  unsigned long *delay_off,
				  int invert);
/**
 * led_set_brightness - set LED brightness
 * @led_cdev: the LED to set
 * @brightness: the brightness to set it to
 *
 * Set an LED's brightness, and, if necessary, cancel the
 * software blink timer that implements blinking when the
 * hardware doesn't. This function is guaranteed not to sleep.
 */
extern void led_set_brightness(struct led_classdev *led_cdev,
			       enum led_brightness brightness);

/**
 * led_set_brightness_sync - set LED brightness synchronously
 * @led_cdev: the LED to set
 * @brightness: the brightness to set it to
 *
 * Set an LED's brightness immediately. This function will block
 * the caller for the time required for accessing device registers,
 * and it can sleep.
 *
 * Returns: 0 on success or negative error value on failure
 */
extern int led_set_brightness_sync(struct led_classdev *led_cdev,
				   enum led_brightness value);

/**
 * led_update_brightness - update LED brightness
 * @led_cdev: the LED to query
 *
 * Get an LED's current brightness and update led_cdev->brightness
 * member with the obtained value.
 *
 * Returns: 0 on success or negative error value on failure
 */
extern int led_update_brightness(struct led_classdev *led_cdev);

/**
 * led_sysfs_disable - disable LED sysfs interface
 * @led_cdev: the LED to set
 *
 * Disable the led_cdev's sysfs interface.
 */
extern void led_sysfs_disable(struct led_classdev *led_cdev);

/**
 * led_sysfs_enable - enable LED sysfs interface
 * @led_cdev: the LED to set
 *
 * Enable the led_cdev's sysfs interface.
 */
extern void led_sysfs_enable(struct led_classdev *led_cdev);

/**
 * led_sysfs_is_disabled - check if LED sysfs interface is disabled
 * @led_cdev: the LED to query
 *
 * Returns: true if the led_cdev's sysfs interface is disabled.
 */

static inline bool led_sysfs_is_disabled(struct led_classdev *led_cdev) { return led_cdev->flags & LED_SYSFS_DISABLE; }

Contributors

PersonTokensPropCommitsCommitProp
Jacek Anaszewski19100.00%1100.00%
Total19100.00%1100.00%

/* * LED Triggers */ /* Registration functions for simple triggers */ #define DEFINE_LED_TRIGGER(x) static struct led_trigger *x; #define DEFINE_LED_TRIGGER_GLOBAL(x) struct led_trigger *x; #ifdef CONFIG_LEDS_TRIGGERS #define TRIG_NAME_MAX 50 struct led_trigger { /* Trigger Properties */ const char *name; void (*activate)(struct led_classdev *led_cdev); void (*deactivate)(struct led_classdev *led_cdev); /* LEDs under control by this trigger (for simple triggers) */ rwlock_t leddev_list_lock; struct list_head led_cdevs; /* Link to next registered trigger */ struct list_head next_trig; }; ssize_t led_trigger_store(struct device *dev, struct device_attribute *attr, const char *buf, size_t count); ssize_t led_trigger_show(struct device *dev, struct device_attribute *attr, char *buf); /* Registration functions for complex triggers */ extern int led_trigger_register(struct led_trigger *trigger); extern void led_trigger_unregister(struct led_trigger *trigger); extern int devm_led_trigger_register(struct device *dev, struct led_trigger *trigger); extern void led_trigger_register_simple(const char *name, struct led_trigger **trigger); extern void led_trigger_unregister_simple(struct led_trigger *trigger); extern void led_trigger_event(struct led_trigger *trigger, enum led_brightness event); extern void led_trigger_blink(struct led_trigger *trigger, unsigned long *delay_on, unsigned long *delay_off); extern void led_trigger_blink_oneshot(struct led_trigger *trigger, unsigned long *delay_on, unsigned long *delay_off, int invert); extern void led_trigger_set_default(struct led_classdev *led_cdev); extern void led_trigger_set(struct led_classdev *led_cdev, struct led_trigger *trigger); extern void led_trigger_remove(struct led_classdev *led_cdev);
static inline void *led_get_trigger_data(struct led_classdev *led_cdev) { return led_cdev->trigger_data; }

Contributors

PersonTokensPropCommitsCommitProp
Jacek Anaszewski18100.00%1100.00%
Total18100.00%1100.00%

/** * led_trigger_rename_static - rename a trigger * @name: the new trigger name * @trig: the LED trigger to rename * * Change a LED trigger name by copying the string passed in * name into current trigger name, which MUST be large * enough for the new string. * * Note that name must NOT point to the same string used * during LED registration, as that could lead to races. * * This is meant to be used on triggers with statically * allocated name. */ extern void led_trigger_rename_static(const char *name, struct led_trigger *trig); #else /* Trigger has no members */ struct led_trigger {}; /* Trigger inline empty functions */
static inline void led_trigger_register_simple(const char *name, struct led_trigger **trigger) {}

Contributors

PersonTokensPropCommitsCommitProp
Kim (Woogyom) Milo1376.47%150.00%
Richard Purdie423.53%150.00%
Total17100.00%2100.00%


static inline void led_trigger_unregister_simple(struct led_trigger *trigger) {}

Contributors

PersonTokensPropCommitsCommitProp
Kim (Woogyom) Milo872.73%150.00%
Richard Purdie327.27%150.00%
Total11100.00%2100.00%


static inline void led_trigger_event(struct led_trigger *trigger, enum led_brightness event) {}

Contributors

PersonTokensPropCommitsCommitProp
Kim (Woogyom) Milo1173.33%150.00%
Richard Purdie426.67%150.00%
Total15100.00%2100.00%


static inline void led_trigger_blink(struct led_trigger *trigger, unsigned long *delay_on, unsigned long *delay_off) {}

Contributors

PersonTokensPropCommitsCommitProp
Michael Grzeschik21100.00%1100.00%
Total21100.00%1100.00%


static inline void led_trigger_blink_oneshot(struct led_trigger *trigger, unsigned long *delay_on, unsigned long *delay_off, int invert) {}

Contributors

PersonTokensPropCommitsCommitProp
Michael Grzeschik24100.00%1100.00%
Total24100.00%1100.00%


static inline void led_trigger_set_default(struct led_classdev *led_cdev) {}

Contributors

PersonTokensPropCommitsCommitProp
Jacek Anaszewski11100.00%1100.00%
Total11100.00%1100.00%


static inline void led_trigger_set(struct led_classdev *led_cdev, struct led_trigger *trigger) {}

Contributors

PersonTokensPropCommitsCommitProp
Jacek Anaszewski16100.00%1100.00%
Total16100.00%1100.00%


static inline void led_trigger_remove(struct led_classdev *led_cdev) {}

Contributors

PersonTokensPropCommitsCommitProp
Jacek Anaszewski11100.00%1100.00%
Total11100.00%1100.00%


static inline void *led_get_trigger_data(struct led_classdev *led_cdev) { return NULL; }

Contributors

PersonTokensPropCommitsCommitProp
Jacek Anaszewski16100.00%1100.00%
Total16100.00%1100.00%

#endif /* CONFIG_LEDS_TRIGGERS */ /* Trigger specific functions */ #ifdef CONFIG_LEDS_TRIGGER_DISK extern void ledtrig_disk_activity(void); #else
static inline void ledtrig_disk_activity(void) {}

Contributors

PersonTokensPropCommitsCommitProp
Kim (Woogyom) Milo787.50%150.00%
Stephan Linz112.50%150.00%
Total8100.00%2100.00%

#endif #ifdef CONFIG_LEDS_TRIGGER_MTD extern void ledtrig_mtd_activity(void); #else
static inline void ledtrig_mtd_activity(void) {}

Contributors

PersonTokensPropCommitsCommitProp
Ezequiel García8100.00%1100.00%
Total8100.00%1100.00%

#endif #if defined(CONFIG_LEDS_TRIGGER_CAMERA) || defined(CONFIG_LEDS_TRIGGER_CAMERA_MODULE) extern void ledtrig_flash_ctrl(bool on); extern void ledtrig_torch_ctrl(bool on); #else
static inline void ledtrig_flash_ctrl(bool on) {}

Contributors

PersonTokensPropCommitsCommitProp
Kim (Woogyom) Milo9100.00%1100.00%
Total9100.00%1100.00%


static inline void ledtrig_torch_ctrl(bool on) {}

Contributors

PersonTokensPropCommitsCommitProp
Kim (Woogyom) Milo9100.00%1100.00%
Total9100.00%1100.00%

#endif /* * Generic LED platform data for describing LED names and default triggers. */ struct led_info { const char *name; const char *default_trigger; int flags; }; struct led_platform_data { int num_leds; struct led_info *leds; }; struct gpio_desc; typedef int (*gpio_blink_set_t)(struct gpio_desc *desc, int state, unsigned long *delay_on, unsigned long *delay_off); /* For the leds-gpio driver */ struct gpio_led { const char *name; const char *default_trigger; unsigned gpio; unsigned active_low : 1; unsigned retain_state_suspended : 1; unsigned panic_indicator : 1; unsigned default_state : 2; unsigned retain_state_shutdown : 1; /* default_state should be one of LEDS_GPIO_DEFSTATE_(ON|OFF|KEEP) */ struct gpio_desc *gpiod; }; #define LEDS_GPIO_DEFSTATE_OFF 0 #define LEDS_GPIO_DEFSTATE_ON 1 #define LEDS_GPIO_DEFSTATE_KEEP 2 struct gpio_led_platform_data { int num_leds; const struct gpio_led *leds; #define GPIO_LED_NO_BLINK_LOW 0 /* No blink GPIO state low */ #define GPIO_LED_NO_BLINK_HIGH 1 /* No blink GPIO state high */ #define GPIO_LED_BLINK 2 /* Please, blink */ gpio_blink_set_t gpio_blink_set; }; #ifdef CONFIG_NEW_LEDS struct platform_device *gpio_led_register_device( int id, const struct gpio_led_platform_data *pdata); #else
static inline struct platform_device *gpio_led_register_device( int id, const struct gpio_led_platform_data *pdata) { return 0; }

Contributors

PersonTokensPropCommitsCommitProp
Andrew F. Davis21100.00%1100.00%
Total21100.00%1100.00%

#endif enum cpu_led_event { CPU_LED_IDLE_START, /* CPU enters idle */ CPU_LED_IDLE_END, /* CPU idle ends */ CPU_LED_START, /* Machine starts, especially resume */ CPU_LED_STOP, /* Machine stops, especially suspend */ CPU_LED_HALTED, /* Machine shutdown */ }; #ifdef CONFIG_LEDS_TRIGGER_CPU extern void ledtrig_cpu(enum cpu_led_event evt); #else
static inline void ledtrig_cpu(enum cpu_led_event evt) { return; }

Contributors

PersonTokensPropCommitsCommitProp
Bryan Wu12100.00%1100.00%
Total12100.00%1100.00%

#endif #ifdef CONFIG_LEDS_BRIGHTNESS_HW_CHANGED extern void led_classdev_notify_brightness_hw_changed( struct led_classdev *led_cdev, enum led_brightness brightness); #else
static inline void led_classdev_notify_brightness_hw_changed( struct led_classdev *led_cdev, enum led_brightness brightness) { }

Contributors

PersonTokensPropCommitsCommitProp
Hans de Goede15100.00%1100.00%
Total15100.00%1100.00%

#endif #endif /* __LINUX_LEDS_H_INCLUDED */

Overall Contributors

PersonTokensPropCommitsCommitProp
Richard Purdie29521.36%710.45%
Jacek Anaszewski27019.55%1116.42%
Kim (Woogyom) Milo1107.97%22.99%
Hans de Goede805.79%34.48%
Fabio Baltieri614.42%22.99%
Heiner Kallweit533.84%45.97%
Johannes Berg503.62%22.99%
Bryan Wu483.48%11.49%
Michael Grzeschik453.26%11.49%
Raphaël Assénat332.39%11.49%
Rafał Miłecki322.32%11.49%
Nate Case312.24%11.49%
Björn Andersson292.10%11.49%
Ezequiel García292.10%34.48%
Andrew F. Davis282.03%11.49%
Márton Németh221.59%11.49%
Trent Piepho221.59%22.99%
Vasily Khoruzhick201.45%11.49%
Uwe Kleine-König171.23%22.99%
Jingoo Han161.16%11.49%
Henrique de Moraes Holschuh141.01%11.49%
Benjamin Herrenschmidt141.01%11.49%
Andrew Jeffery90.65%11.49%
Rafael J. Wysocki70.51%22.99%
Tony Makkiel70.51%11.49%
Johan Hovold70.51%11.49%
Mika Westerberg50.36%11.49%
Jiri Kosina50.36%11.49%
Shuah Khan50.36%22.99%
Andi Shyti40.29%11.49%
Stephan Linz30.22%11.49%
Ben Dooks30.22%11.49%
Guennadi Liakhovetski20.14%11.49%
Yoichi Yuasa20.14%11.49%
Anton Vorontsov10.07%11.49%
Wolfram Sang10.07%11.49%
Herbert Valerio Riedel10.07%11.49%
Total1381100.00%67100.00%
Directory: include/linux
Information contained on this website is for historical information purposes only and does not indicate or represent copyright ownership.
Created with cregit.