blob: 2389b3dfe0de7cc5ff4b18c077fc974e9135147f [file] [log] [blame]
/* Copyright 2018 The Chromium OS Authors. All rights reserved.
* Use of this source code is governed by a BSD-style license that can be
* found in the LICENSE file.
*/
#ifndef __CROS_EC_KEYBOARD_BACKLIGHT_H
#define __CROS_EC_KEYBOARD_BACKLIGHT_H
struct kblight_conf {
const struct kblight_drv *drv;
};
struct kblight_drv {
/**
* Initialize the keyboard backlight controller
* @return EC_SUCCESS or EC_ERROR_*
*/
int (*init)(void);
/**
* Set the brightness
* @param percent
* @return EC_SUCCESS or EC_ERROR_*
*/
int (*set)(int percent);
/**
* Get the current brightness
* @return Brightness in percentage
*/
int (*get)(void);
/**
* Enable or disable keyboard backlight
* @param enable: 1=Enable, 0=Disable.
* @return EC_SUCCESS or EC_ERROR_*
*/
int (*enable)(int enable);
};
/**
* Initialize keyboard backlight per board
*/
void board_kblight_init(void);
/**
* Set keyboard backlight brightness
*
* @param percent Brightness in percentage
* @return EC_SUCCESS or EC_ERROR_*
*/
int kblight_set(int percent);
/**
* Get keyboard backlight brightness
*
* @return Brightness in percentage
*/
int kblight_get(void);
/**
* Enable or disable keyboard backlight
*
* @param enable: 1=Enable, 0=Disable.
* @return EC_SUCCESS or EC_ERROR_*
*/
int kblight_enable(int enable);
/**
* Register keyboard backlight controller
*
* @param drv: Driver of keyboard backlight controller
* @return EC_SUCCESS or EC_ERROR_*
*/
int kblight_register(const struct kblight_drv *drv);
extern const struct kblight_drv kblight_pwm;
#endif /* __CROS_EC_KEYBOARD_BACKLIGHT_H */