Files
OpenCellular/include/led_common.h
Dave Parker 63a71a6adc Peppy ectool led command
Glue between the existing ectool led command and the
led control logic.

BUG=chrome-os-partner:20776
BRANCH=peppy
TEST=Manual. Run "ectool led" commands:

Should pass:
ectool led power blue|yellow|off|auto|blue=1 yellow=1
ectool led battery blue|yellow|off|auto|blue=1 yellow=1

Should fail:
ectool led adapter <color>
ectool led power|battery red|green|white

Signed-off-by: Dave Parker <dparker@chromium.org>
Change-Id: I2540940baa553866760dd9ae62278b6b845793ef
Reviewed-on: https://gerrit.chromium.org/gerrit/64627
2013-08-07 12:43:48 -07:00

64 lines
1.6 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 diable 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);
#endif /* __CROS_EC_LED_COMMON_H */