liz/flipperzero-firmware
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

[FL-41] api-hal doxygen documentation (#387)

Browse Source 
* targets/api-hal: rework documentation in doxygen style
* core/api-hal: rework documentation in doxygen style
* core/furi: rework documentation in doxygen style
* drivers: rework documentation in doxygen style

Co-authored-by: あく <alleteam@gmail.com>
This commit is contained in:
gornekich
2021-03-24 12:35:33 +03:00
committed by GitHub
parent cc263d743b
commit 610f4f5d73
23 changed files with 325 additions and 161 deletions
Download Patch File Download Diff File Expand all files Collapse all files

52
firmware/targets/api-hal-include/api-hal-power.h
View File

@@ -8,89 +8,89 @@
extern "C" {
#endif
/** Power IC type */
typedef enum {
ApiHalPowerICCharger,
ApiHalPowerICFuelGauge,
} ApiHalPowerIC;
/* Initialize drivers */
/** Initialize drivers */
void api_hal_power_init();
/* Get current insomnia level
/**
* Get current insomnia level
* @return insomnia level: 0 - no insomnia, >0 - insomnia, bearer count.
*/
uint16_t api_hal_power_insomnia_level();
/* Enter insomnia mode
/**
* Enter insomnia mode
* Prevents device from going to sleep
* @warning Internally increases insomnia level
* Must be paired with api_hal_power_insomnia_exit
*/
void api_hal_power_insomnia_enter();
/* Exit insomnia mode
/**
* Exit insomnia mode
* Allow device to go to sleep
* @warning Internally decreases insomnia level.
* Must be paired with api_hal_power_insomnia_enter
*/
void api_hal_power_insomnia_exit();
/* Check if deep sleep availble */
/** Check if deep sleep availble */
bool api_hal_power_deep_available();
/* Go to sleep */
/** Go to sleep */
void api_hal_power_sleep();
/* Get predicted remaining battery capacity in percents */
/** Get predicted remaining battery capacity in percents */
uint8_t api_hal_power_get_pct();
/* Get battery health state in percents */
/** Get battery health state in percents */
uint8_t api_hal_power_get_bat_health_pct();
/* Get charging status */
/** Get charging status */
bool api_hal_power_is_charging();
/* Poweroff system */
/** Poweroff system */
void api_hal_power_off();
/* OTG enable */
/** OTG enable */
void api_hal_power_enable_otg();
/* OTG disable */
/** OTG disable */
void api_hal_power_disable_otg();
/* Get remaining battery battery capacity in mAh */
/** Get remaining battery battery capacity in mAh */
uint32_t api_hal_power_get_battery_remaining_capacity();
/* Get full charge battery capacity in mAh */
/** Get full charge battery capacity in mAh */
uint32_t api_hal_power_get_battery_full_capacity();
/* Get battery voltage in V */
/** Get battery voltage in V */
float api_hal_power_get_battery_voltage(ApiHalPowerIC ic);
/* Get battery current in A */
/** Get battery current in A */
float api_hal_power_get_battery_current(ApiHalPowerIC ic);
/* Get temperature in C */
/** Get temperature in C */
float api_hal_power_get_battery_temperature(ApiHalPowerIC ic);
/* Get System voltage in V */
/** Get System voltage in V */
float api_hal_power_get_system_voltage();
/* Get USB voltage in V */
/** Get USB voltage in V */
float api_hal_power_get_usb_voltage();
/* Get power system component state */
/** Get power system component state */
void api_hal_power_dump_state(string_t buffer);
/**
* @brief Enable 3.3v on external gpio and sd card
*/
/** Enable 3.3v on external gpio and sd card */
void api_hal_power_enable_external_3_3v();
/**
* @brief Disable 3.3v on external gpio and sd card
*/
/** Disable 3.3v on external gpio and sd card */
void api_hal_power_disable_external_3_3v();
#ifdef __cplusplus