2005-04-17 02:20:36 +04:00
|
|
|
/*
|
|
|
|
* Backlight Lowlevel Control Abstraction
|
|
|
|
*
|
|
|
|
* Copyright (C) 2003,2004 Hewlett-Packard Company
|
|
|
|
*
|
|
|
|
*/
|
|
|
|
|
|
|
|
#ifndef _LINUX_BACKLIGHT_H
|
|
|
|
#define _LINUX_BACKLIGHT_H
|
|
|
|
|
|
|
|
#include <linux/device.h>
|
2007-02-09 01:25:09 +03:00
|
|
|
#include <linux/mutex.h>
|
2005-04-17 02:20:36 +04:00
|
|
|
#include <linux/notifier.h>
|
|
|
|
|
2007-02-09 01:25:09 +03:00
|
|
|
/* Notes on locking:
|
|
|
|
*
|
2007-02-11 02:07:48 +03:00
|
|
|
* backlight_device->ops_lock is an internal backlight lock protecting the
|
|
|
|
* ops pointer and no code outside the core should need to touch it.
|
2007-02-09 01:25:09 +03:00
|
|
|
*
|
|
|
|
* Access to update_status() is serialised by the update_lock mutex since
|
|
|
|
* most drivers seem to need this and historically get it wrong.
|
|
|
|
*
|
|
|
|
* Most drivers don't need locking on their get_brightness() method.
|
|
|
|
* If yours does, you need to implement it in the driver. You can use the
|
|
|
|
* update_lock mutex if appropriate.
|
|
|
|
*
|
|
|
|
* Any other use of the locks below is probably wrong.
|
|
|
|
*/
|
|
|
|
|
2009-07-14 20:06:02 +04:00
|
|
|
enum backlight_update_reason {
|
|
|
|
BACKLIGHT_UPDATE_HOTKEY,
|
|
|
|
BACKLIGHT_UPDATE_SYSFS,
|
|
|
|
};
|
|
|
|
|
2011-03-23 02:30:21 +03:00
|
|
|
enum backlight_type {
|
|
|
|
BACKLIGHT_RAW = 1,
|
|
|
|
BACKLIGHT_PLATFORM,
|
|
|
|
BACKLIGHT_FIRMWARE,
|
|
|
|
BACKLIGHT_TYPE_MAX,
|
|
|
|
};
|
|
|
|
|
2005-04-17 02:20:36 +04:00
|
|
|
struct backlight_device;
|
|
|
|
struct fb_info;
|
|
|
|
|
2007-02-11 02:07:48 +03:00
|
|
|
struct backlight_ops {
|
2010-01-18 17:16:07 +03:00
|
|
|
unsigned int options;
|
2009-01-07 00:00:19 +03:00
|
|
|
|
|
|
|
#define BL_CORE_SUSPENDRESUME (1 << 0)
|
|
|
|
|
2006-03-31 14:31:49 +04:00
|
|
|
/* Notify the backlight driver some property has changed */
|
2010-01-18 17:16:07 +03:00
|
|
|
int (*update_status)(struct backlight_device *);
|
2006-03-31 14:31:49 +04:00
|
|
|
/* Return the current backlight brightness (accounting for power,
|
|
|
|
fb_blank etc.) */
|
2010-01-18 17:16:07 +03:00
|
|
|
int (*get_brightness)(struct backlight_device *);
|
2005-04-17 02:20:36 +04:00
|
|
|
/* Check if given framebuffer device is the one bound to this backlight;
|
|
|
|
return 0 if not, !=0 if it is. If NULL, backlight always matches the fb. */
|
2010-02-21 02:20:01 +03:00
|
|
|
int (*check_fb)(struct backlight_device *, struct fb_info *);
|
2007-02-11 02:07:48 +03:00
|
|
|
};
|
2006-03-31 14:31:49 +04:00
|
|
|
|
2007-02-11 02:07:48 +03:00
|
|
|
/* This structure defines all the properties of a backlight */
|
|
|
|
struct backlight_properties {
|
2006-03-31 14:31:49 +04:00
|
|
|
/* Current User requested brightness (0 - max_brightness) */
|
|
|
|
int brightness;
|
|
|
|
/* Maximal value for brightness (read-only) */
|
|
|
|
int max_brightness;
|
|
|
|
/* Current FB Power mode (0: full on, 1..3: power saving
|
|
|
|
modes; 4: full off), see FB_BLANK_XXX */
|
|
|
|
int power;
|
|
|
|
/* FB Blanking active? (values as for power) */
|
2009-01-07 00:00:19 +03:00
|
|
|
/* Due to be removed, please use (state & BL_CORE_FBBLANK) */
|
2006-03-31 14:31:49 +04:00
|
|
|
int fb_blank;
|
2011-03-23 02:30:21 +03:00
|
|
|
/* Backlight type */
|
|
|
|
enum backlight_type type;
|
2009-01-07 00:00:19 +03:00
|
|
|
/* Flags used to signal drivers of state changes */
|
|
|
|
/* Upper 4 bits are reserved for driver internal use */
|
|
|
|
unsigned int state;
|
|
|
|
|
|
|
|
#define BL_CORE_SUSPENDED (1 << 0) /* backlight is suspended */
|
|
|
|
#define BL_CORE_FBBLANK (1 << 1) /* backlight is under an fb blank event */
|
|
|
|
#define BL_CORE_DRIVER4 (1 << 28) /* reserved for driver specific use */
|
|
|
|
#define BL_CORE_DRIVER3 (1 << 29) /* reserved for driver specific use */
|
|
|
|
#define BL_CORE_DRIVER2 (1 << 30) /* reserved for driver specific use */
|
|
|
|
#define BL_CORE_DRIVER1 (1 << 31) /* reserved for driver specific use */
|
|
|
|
|
2005-04-17 02:20:36 +04:00
|
|
|
};
|
|
|
|
|
|
|
|
struct backlight_device {
|
2007-02-11 02:07:48 +03:00
|
|
|
/* Backlight properties */
|
|
|
|
struct backlight_properties props;
|
|
|
|
|
2007-02-09 01:25:09 +03:00
|
|
|
/* Serialise access to update_status method */
|
|
|
|
struct mutex update_lock;
|
2007-02-11 02:07:48 +03:00
|
|
|
|
|
|
|
/* This protects the 'ops' field. If 'ops' is NULL, the driver that
|
|
|
|
registered this device has been unloaded, and if class_get_devdata()
|
|
|
|
points to something in the body of that driver, it is also invalid. */
|
|
|
|
struct mutex ops_lock;
|
2009-12-14 02:58:57 +03:00
|
|
|
const struct backlight_ops *ops;
|
2007-02-11 02:07:48 +03:00
|
|
|
|
2005-04-17 02:20:36 +04:00
|
|
|
/* The framebuffer notifier block */
|
|
|
|
struct notifier_block fb_notif;
|
2007-07-09 15:17:24 +04:00
|
|
|
|
2013-10-11 17:27:43 +04:00
|
|
|
/* list entry of all registered backlight devices */
|
|
|
|
struct list_head entry;
|
|
|
|
|
2007-07-09 15:17:24 +04:00
|
|
|
struct device dev;
|
2005-04-17 02:20:36 +04:00
|
|
|
};
|
|
|
|
|
2007-02-09 01:25:09 +03:00
|
|
|
static inline void backlight_update_status(struct backlight_device *bd)
|
|
|
|
{
|
|
|
|
mutex_lock(&bd->update_lock);
|
2007-02-11 02:07:48 +03:00
|
|
|
if (bd->ops && bd->ops->update_status)
|
|
|
|
bd->ops->update_status(bd);
|
2007-02-09 01:25:09 +03:00
|
|
|
mutex_unlock(&bd->update_lock);
|
|
|
|
}
|
|
|
|
|
2005-04-17 02:20:36 +04:00
|
|
|
extern struct backlight_device *backlight_device_register(const char *name,
|
2010-02-18 00:39:44 +03:00
|
|
|
struct device *dev, void *devdata, const struct backlight_ops *ops,
|
|
|
|
const struct backlight_properties *props);
|
2013-07-04 02:05:13 +04:00
|
|
|
extern struct backlight_device *devm_backlight_device_register(
|
|
|
|
struct device *dev, const char *name, struct device *parent,
|
|
|
|
void *devdata, const struct backlight_ops *ops,
|
|
|
|
const struct backlight_properties *props);
|
2005-04-17 02:20:36 +04:00
|
|
|
extern void backlight_device_unregister(struct backlight_device *bd);
|
2013-07-04 02:05:13 +04:00
|
|
|
extern void devm_backlight_device_unregister(struct device *dev,
|
|
|
|
struct backlight_device *bd);
|
2009-07-14 20:06:02 +04:00
|
|
|
extern void backlight_force_update(struct backlight_device *bd,
|
|
|
|
enum backlight_update_reason reason);
|
2013-10-11 17:27:43 +04:00
|
|
|
extern bool backlight_device_registered(enum backlight_type type);
|
2005-04-17 02:20:36 +04:00
|
|
|
|
2007-07-09 15:17:24 +04:00
|
|
|
#define to_backlight_device(obj) container_of(obj, struct backlight_device, dev)
|
|
|
|
|
|
|
|
static inline void * bl_get_data(struct backlight_device *bl_dev)
|
|
|
|
{
|
|
|
|
return dev_get_drvdata(&bl_dev->dev);
|
|
|
|
}
|
2005-04-17 02:20:36 +04:00
|
|
|
|
2007-09-03 03:27:00 +04:00
|
|
|
struct generic_bl_info {
|
|
|
|
const char *name;
|
|
|
|
int max_intensity;
|
|
|
|
int default_intensity;
|
|
|
|
int limit_mask;
|
|
|
|
void (*set_bl_intensity)(int intensity);
|
|
|
|
void (*kick_battery)(void);
|
|
|
|
};
|
|
|
|
|
2012-12-18 04:01:06 +04:00
|
|
|
#ifdef CONFIG_OF
|
|
|
|
struct backlight_device *of_find_backlight_by_node(struct device_node *node);
|
|
|
|
#else
|
|
|
|
static inline struct backlight_device *
|
|
|
|
of_find_backlight_by_node(struct device_node *node)
|
|
|
|
{
|
|
|
|
return NULL;
|
|
|
|
}
|
|
|
|
#endif
|
|
|
|
|
2005-04-17 02:20:36 +04:00
|
|
|
#endif
|