7c9d5ace14
* Generate api docs from source code * Add a bunch of doxygen comments * more doxygen comments * Add the in-progress api docs * script to generate docs from travis * Add doc generation to the travis job * make travis_docs.sh commit the work it does * make sure the docs script exits cleanly
116 lines
2.8 KiB
C
116 lines
2.8 KiB
C
#include <stdint.h>
|
|
#include <stdbool.h>
|
|
#include "eeprom.h"
|
|
#include "eeconfig.h"
|
|
|
|
/** \brief eeconfig initialization
|
|
*
|
|
* FIXME: needs doc
|
|
*/
|
|
void eeconfig_init(void)
|
|
{
|
|
eeprom_update_word(EECONFIG_MAGIC, EECONFIG_MAGIC_NUMBER);
|
|
eeprom_update_byte(EECONFIG_DEBUG, 0);
|
|
eeprom_update_byte(EECONFIG_DEFAULT_LAYER, 0);
|
|
eeprom_update_byte(EECONFIG_KEYMAP, 0);
|
|
eeprom_update_byte(EECONFIG_MOUSEKEY_ACCEL, 0);
|
|
#ifdef BACKLIGHT_ENABLE
|
|
eeprom_update_byte(EECONFIG_BACKLIGHT, 0);
|
|
#endif
|
|
#ifdef AUDIO_ENABLE
|
|
eeprom_update_byte(EECONFIG_AUDIO, 0xFF); // On by default
|
|
#endif
|
|
#ifdef RGBLIGHT_ENABLE
|
|
eeprom_update_dword(EECONFIG_RGBLIGHT, 0);
|
|
#endif
|
|
#ifdef STENO_ENABLE
|
|
eeprom_update_byte(EECONFIG_STENOMODE, 0);
|
|
#endif
|
|
}
|
|
|
|
/** \brief eeconfig enable
|
|
*
|
|
* FIXME: needs doc
|
|
*/
|
|
void eeconfig_enable(void)
|
|
{
|
|
eeprom_update_word(EECONFIG_MAGIC, EECONFIG_MAGIC_NUMBER);
|
|
}
|
|
|
|
/** \brief eeconfig disable
|
|
*
|
|
* FIXME: needs doc
|
|
*/
|
|
void eeconfig_disable(void)
|
|
{
|
|
eeprom_update_word(EECONFIG_MAGIC, 0xFFFF);
|
|
}
|
|
|
|
/** \brief eeconfig is enabled
|
|
*
|
|
* FIXME: needs doc
|
|
*/
|
|
bool eeconfig_is_enabled(void)
|
|
{
|
|
return (eeprom_read_word(EECONFIG_MAGIC) == EECONFIG_MAGIC_NUMBER);
|
|
}
|
|
|
|
/** \brief eeconfig read debug
|
|
*
|
|
* FIXME: needs doc
|
|
*/
|
|
uint8_t eeconfig_read_debug(void) { return eeprom_read_byte(EECONFIG_DEBUG); }
|
|
/** \brief eeconfig update debug
|
|
*
|
|
* FIXME: needs doc
|
|
*/
|
|
void eeconfig_update_debug(uint8_t val) { eeprom_update_byte(EECONFIG_DEBUG, val); }
|
|
|
|
/** \brief eeconfig read default layer
|
|
*
|
|
* FIXME: needs doc
|
|
*/
|
|
uint8_t eeconfig_read_default_layer(void) { return eeprom_read_byte(EECONFIG_DEFAULT_LAYER); }
|
|
/** \brief eeconfig update default layer
|
|
*
|
|
* FIXME: needs doc
|
|
*/
|
|
void eeconfig_update_default_layer(uint8_t val) { eeprom_update_byte(EECONFIG_DEFAULT_LAYER, val); }
|
|
|
|
/** \brief eeconfig read keymap
|
|
*
|
|
* FIXME: needs doc
|
|
*/
|
|
uint8_t eeconfig_read_keymap(void) { return eeprom_read_byte(EECONFIG_KEYMAP); }
|
|
/** \brief eeconfig update keymap
|
|
*
|
|
* FIXME: needs doc
|
|
*/
|
|
void eeconfig_update_keymap(uint8_t val) { eeprom_update_byte(EECONFIG_KEYMAP, val); }
|
|
|
|
#ifdef BACKLIGHT_ENABLE
|
|
/** \brief eeconfig read backlight
|
|
*
|
|
* FIXME: needs doc
|
|
*/
|
|
uint8_t eeconfig_read_backlight(void) { return eeprom_read_byte(EECONFIG_BACKLIGHT); }
|
|
/** \brief eeconfig update backlight
|
|
*
|
|
* FIXME: needs doc
|
|
*/
|
|
void eeconfig_update_backlight(uint8_t val) { eeprom_update_byte(EECONFIG_BACKLIGHT, val); }
|
|
#endif
|
|
|
|
#ifdef AUDIO_ENABLE
|
|
/** \brief eeconfig read audio
|
|
*
|
|
* FIXME: needs doc
|
|
*/
|
|
uint8_t eeconfig_read_audio(void) { return eeprom_read_byte(EECONFIG_AUDIO); }
|
|
/** \brief eeconfig update audio
|
|
*
|
|
* FIXME: needs doc
|
|
*/
|
|
void eeconfig_update_audio(uint8_t val) { eeprom_update_byte(EECONFIG_AUDIO, val); }
|
|
#endif
|