summaryrefslogtreecommitdiff
path: root/include/led_pwm.h
blob: 7f286130e75478af547613c8339ec617b13096d8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
/* 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_LED_PWM_H
#define __CROS_EC_LED_PWM_H

#include "ec_commands.h"

#ifdef CONFIG_ZEPHYR
#include "drivers/pwm.h"
#endif

#ifdef CONFIG_ZEPHYR
#define PWM_LED_NO_CHANNEL NULL

/* This could really be pwm_dt_spec. */
struct pwm_led_dt_channel {
	const struct device *dev;
	uint32_t channel;
	pwm_flags_t flags;
	uint32_t period_us;
};

struct pwm_led {
	const struct pwm_led_dt_channel *ch0;
	const struct pwm_led_dt_channel *ch1;
	const struct pwm_led_dt_channel *ch2;

	void (*set_duty)(const struct pwm_led_dt_channel *ch, int percent);
};
#else
#define PWM_LED_NO_CHANNEL ((enum pwm_channel)(-1))

struct pwm_led {
	enum pwm_channel ch0;
	enum pwm_channel ch1;
	enum pwm_channel ch2;

	void (*enable)(enum pwm_channel ch, int enabled);
	void (*set_duty)(enum pwm_channel ch, int percent);
};
#endif

struct pwm_led_color_map {
	uint8_t ch0;
	uint8_t ch1;
	uint8_t ch2;
};

enum pwm_led_id {
	PWM_LED0 = 0,
#if CONFIG_LED_PWM_COUNT >= 2
	PWM_LED1,
#endif /* CONFIG_LED_PWM_COUNT > 2 */
};

/*
 * A mapping of color to LED duty cycles per channel.
 *
 * This should be defined by the boards to declare what each color looks like.
 * There should be an entry for every enum ec_led_colors value.  For colors that
 * are impossible for a given board, they should define a duty cycle of 0 for
 * all applicable channels.  (e.g. A bi-color LED which has a red and green
 * channel should define all 0s for EC_LED_COLOR_BLUE and EC_LED_COLOR_WHITE.)
 */
extern struct pwm_led_color_map led_color_map[EC_LED_COLOR_COUNT];

/*
 * A map of the PWM channels to logical PWM LEDs.
 *
 * A logical PWM LED would be considered as "per diffuser".  There may be 1-3
 * channels per diffuser and they should form a single entry in pwm_leds.  If a
 * channel is not used, simply define that channel as PWM_LED_NO_CHANNEL.
 */
extern struct pwm_led pwm_leds[CONFIG_LED_PWM_COUNT];

void set_pwm_led_color(enum pwm_led_id id, int color);

#endif /* defined(__CROS_EC_LED_PWM_H) */