Files
OpenCellular/include/led_common.h
Martin Roth 897ce78bdd Fix various misspellings in comments
No functional changes.

BUG=none
BRANCH=none
TEST=make buildall passes

Change-Id: Ie852feb8e3951975d99dce5a49c17f5f0e8bc791
Signed-off-by: Martin Roth <martinroth@chromium.org>
Reviewed-on: https://chromium-review.googlesource.com/403417
Reviewed-by: Patrick Georgi <pgeorgi@chromium.org>
2016-11-15 17:41:53 -08:00

71 lines
1.7 KiB
C

/* Copyright (c) 2013 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.
*
* Common functions for blinking LEDs.
*/
#ifndef __CROS_EC_LED_COMMON_H
#define __CROS_EC_LED_COMMON_H
#include "ec_commands.h"
/* Defined in led_<board>.c */
extern const enum ec_led_id supported_led_ids[];
/* Defined in led_<board>.c */
extern const int supported_led_ids_count;
/**
* Enable or disable automatic control of an LED.
*
* @param led_id ID of LED to enable or disable automatic control.
* @param enable 1 to enable . 0 to disable
*
*/
void led_auto_control(enum ec_led_id led_id, int enable);
/**
* Whether an LED is under automatic control.
*
* @param led_id ID of LED to query.
*
* @returns 1 if LED is under automatic control. 0 if it is not.
*
*/
int led_auto_control_is_enabled(enum ec_led_id led_id);
/**
* Query brightness per color channel for an LED.
*
* @param led_id ID of LED to query.
* @param brightness_range Points to EC_LED_COLOR_COUNT element array
* where current brightness will be stored.
* Value per color channel:
* 0 unsupported,
* 1 on/off control,
* 2 -> 255 max brightness under PWM control.
*
*/
void led_get_brightness_range(enum ec_led_id, uint8_t *brightness_range);
/**
* Set brightness per color channel for an LED.
*
* @param led_id ID of LED to set.
* @param brightness Brightness per color channel to set.
*
* @returns EC_SUCCESS or EC_ERROR_INVAL
*
*/
int led_set_brightness(enum ec_led_id led_id, const uint8_t *brightness);
/**
* Enable LED.
*
* @param enable 1 to enable LED. 0 to disable.
*
*/
void led_enable(int enable);
#endif /* __CROS_EC_LED_COMMON_H */