backlight.c
7681 bytes
1/*
2Copyright 2013 Mathias Andersson <wraul@dbox.se>
3
4This program is free software: you can redistribute it and/or modify
5it under the terms of the GNU General Public License as published by
6the Free Software Foundation, either version 2 of the License, or
7(at your option) any later version.
8
9This program is distributed in the hope that it will be useful,
10but WITHOUT ANY WARRANTY; without even the implied warranty of
11MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12GNU General Public License for more details.
13
14You should have received a copy of the GNU General Public License
15along with this program. If not, see <http://www.gnu.org/licenses/>.
16*/
17
18#include "backlight.h"
19#include "eeprom.h"
20#include "eeconfig.h"
21#include "debug.h"
22
23backlight_config_t backlight_config;
24
25#ifndef BACKLIGHT_DEFAULT_ON
26# define BACKLIGHT_DEFAULT_ON true
27#endif
28
29#ifndef BACKLIGHT_DEFAULT_LEVEL
30# define BACKLIGHT_DEFAULT_LEVEL BACKLIGHT_LEVELS
31#endif
32
33#ifndef BACKLIGHT_DEFAULT_BREATHING
34# define BACKLIGHT_DEFAULT_BREATHING false
35#else
36# undef BACKLIGHT_DEFAULT_BREATHING
37# define BACKLIGHT_DEFAULT_BREATHING true
38#endif
39
40#ifdef BACKLIGHT_BREATHING
41// TODO: migrate to backlight_config_t
42static uint8_t breathing_period = BREATHING_PERIOD;
43#endif
44
45static void backlight_check_config(void) {
46 /* Add some out of bound checks for backlight config */
47
48 if (backlight_config.level > BACKLIGHT_LEVELS) {
49 backlight_config.level = BACKLIGHT_LEVELS;
50 }
51}
52
53/** \brief Backlight initialization
54 *
55 * FIXME: needs doc
56 */
57void backlight_init(void) {
58 backlight_config.raw = eeconfig_read_backlight();
59 if (!backlight_config.valid) {
60 dprintf("backlight_init backlight_config.valid = 0. Write default values to EEPROM.\n");
61 eeconfig_update_backlight_default();
62 }
63 backlight_check_config();
64
65 backlight_set(backlight_config.enable ? backlight_config.level : 0);
66}
67
68/** \brief Backlight increase
69 *
70 * FIXME: needs doc
71 */
72void backlight_increase(void) {
73 if (backlight_config.level < BACKLIGHT_LEVELS) {
74 backlight_config.level++;
75 }
76 backlight_config.enable = 1;
77 eeconfig_update_backlight(backlight_config.raw);
78 dprintf("backlight increase: %u\n", backlight_config.level);
79 backlight_set(backlight_config.level);
80}
81
82/** \brief Backlight decrease
83 *
84 * FIXME: needs doc
85 */
86void backlight_decrease(void) {
87 if (backlight_config.level > 0) {
88 backlight_config.level--;
89 backlight_config.enable = !!backlight_config.level;
90 eeconfig_update_backlight(backlight_config.raw);
91 }
92 dprintf("backlight decrease: %u\n", backlight_config.level);
93 backlight_set(backlight_config.level);
94}
95
96/** \brief Backlight toggle
97 *
98 * FIXME: needs doc
99 */
100void backlight_toggle(void) {
101 bool enabled = backlight_config.enable;
102 dprintf("backlight toggle: %u\n", enabled);
103 if (enabled)
104 backlight_disable();
105 else
106 backlight_enable();
107}
108
109/** \brief Enable backlight
110 *
111 * FIXME: needs doc
112 */
113void backlight_enable(void) {
114 if (backlight_config.enable) return; // do nothing if backlight is already on
115
116 backlight_config.enable = true;
117 if (backlight_config.raw == 1) // enabled but level == 0
118 backlight_config.level = 1;
119 eeconfig_update_backlight(backlight_config.raw);
120 dprintf("backlight enable\n");
121 backlight_set(backlight_config.level);
122}
123
124/** \brief Disable backlight
125 *
126 * FIXME: needs doc
127 */
128void backlight_disable(void) {
129 if (!backlight_config.enable) return; // do nothing if backlight is already off
130
131 backlight_config.enable = false;
132 eeconfig_update_backlight(backlight_config.raw);
133 dprintf("backlight disable\n");
134 backlight_set(0);
135}
136
137/** /brief Get the backlight status
138 *
139 * FIXME: needs doc
140 */
141bool is_backlight_enabled(void) {
142 return backlight_config.enable;
143}
144
145/** \brief Backlight step through levels
146 *
147 * FIXME: needs doc
148 */
149void backlight_step(void) {
150 backlight_config.level++;
151 if (backlight_config.level > BACKLIGHT_LEVELS) {
152 backlight_config.level = 0;
153 }
154 backlight_config.enable = !!backlight_config.level;
155 eeconfig_update_backlight(backlight_config.raw);
156 dprintf("backlight step: %u\n", backlight_config.level);
157 backlight_set(backlight_config.level);
158}
159
160/** \brief Backlight set level without EEPROM update
161 *
162 */
163void backlight_level_noeeprom(uint8_t level) {
164 if (level > BACKLIGHT_LEVELS) level = BACKLIGHT_LEVELS;
165 backlight_config.level = level;
166 backlight_config.enable = !!backlight_config.level;
167 backlight_set(backlight_config.level);
168}
169
170/** \brief Backlight set level
171 *
172 * FIXME: needs doc
173 */
174void backlight_level(uint8_t level) {
175 backlight_level_noeeprom(level);
176 eeconfig_update_backlight(backlight_config.raw);
177}
178
179uint8_t eeconfig_read_backlight(void) {
180 return eeprom_read_byte(EECONFIG_BACKLIGHT);
181}
182
183void eeconfig_update_backlight(uint8_t val) {
184 eeprom_update_byte(EECONFIG_BACKLIGHT, val);
185}
186
187void eeconfig_update_backlight_current(void) {
188 eeconfig_update_backlight(backlight_config.raw);
189}
190
191void eeconfig_update_backlight_default(void) {
192 backlight_config.valid = true;
193 backlight_config.enable = BACKLIGHT_DEFAULT_ON;
194 backlight_config.breathing = BACKLIGHT_DEFAULT_BREATHING;
195 backlight_config.level = BACKLIGHT_DEFAULT_LEVEL;
196 eeconfig_update_backlight(backlight_config.raw);
197}
198
199/** \brief Get backlight level
200 *
201 * FIXME: needs doc
202 */
203uint8_t get_backlight_level(void) {
204 return backlight_config.level;
205}
206
207#ifdef BACKLIGHT_BREATHING
208/** \brief Backlight breathing toggle
209 *
210 * FIXME: needs doc
211 */
212void backlight_toggle_breathing(void) {
213 bool breathing = backlight_config.breathing;
214 dprintf("backlight breathing toggle: %u\n", breathing);
215 if (breathing)
216 backlight_disable_breathing();
217 else
218 backlight_enable_breathing();
219}
220
221/** \brief Enable backlight breathing
222 *
223 * FIXME: needs doc
224 */
225void backlight_enable_breathing(void) {
226 if (backlight_config.breathing) return; // do nothing if breathing is already on
227
228 backlight_config.breathing = true;
229 eeconfig_update_backlight(backlight_config.raw);
230 dprintf("backlight breathing enable\n");
231 breathing_enable();
232}
233
234/** \brief Disable backlight breathing
235 *
236 * FIXME: needs doc
237 */
238void backlight_disable_breathing(void) {
239 if (!backlight_config.breathing) return; // do nothing if breathing is already off
240
241 backlight_config.breathing = false;
242 eeconfig_update_backlight(backlight_config.raw);
243 dprintf("backlight breathing disable\n");
244 breathing_disable();
245}
246
247/** \brief Get the backlight breathing status
248 *
249 * FIXME: needs doc
250 */
251bool is_backlight_breathing(void) {
252 return backlight_config.breathing;
253}
254
255// following are marked as weak purely for backwards compatibility
256__attribute__((weak)) void breathing_period_set(uint8_t value) {
257 breathing_period = value ? value : 1;
258}
259
260__attribute__((weak)) uint8_t get_breathing_period(void) {
261 return breathing_period;
262}
263
264__attribute__((weak)) void breathing_period_default(void) {
265 breathing_period_set(BREATHING_PERIOD);
266}
267
268__attribute__((weak)) void breathing_period_inc(void) {
269 breathing_period_set(breathing_period + 1);
270}
271
272__attribute__((weak)) void breathing_period_dec(void) {
273 breathing_period_set(breathing_period - 1);
274}
275
276__attribute__((weak)) void breathing_toggle(void) {
277 if (is_breathing())
278 breathing_disable();
279 else
280 breathing_enable();
281}
282
283#endif
284
285// defaults for backlight api
286__attribute__((weak)) void backlight_init_ports(void) {}
287
288__attribute__((weak)) void backlight_set(uint8_t level) {}
289
290__attribute__((weak)) void backlight_task(void) {}