api-hal-power.h 2.2 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798
  1. #pragma once
  2. #include <stdint.h>
  3. #include <stdbool.h>
  4. #include <m-string.h>
  5. #ifdef __cplusplus
  6. extern "C" {
  7. #endif
  8. /** Power IC type */
  9. typedef enum {
  10. ApiHalPowerICCharger,
  11. ApiHalPowerICFuelGauge,
  12. } ApiHalPowerIC;
  13. /** Initialize drivers */
  14. void api_hal_power_init();
  15. /**
  16. * Get current insomnia level
  17. * @return insomnia level: 0 - no insomnia, >0 - insomnia, bearer count.
  18. */
  19. uint16_t api_hal_power_insomnia_level();
  20. /**
  21. * Enter insomnia mode
  22. * Prevents device from going to sleep
  23. * @warning Internally increases insomnia level
  24. * Must be paired with api_hal_power_insomnia_exit
  25. */
  26. void api_hal_power_insomnia_enter();
  27. /**
  28. * Exit insomnia mode
  29. * Allow device to go to sleep
  30. * @warning Internally decreases insomnia level.
  31. * Must be paired with api_hal_power_insomnia_enter
  32. */
  33. void api_hal_power_insomnia_exit();
  34. /** Check if deep sleep availble */
  35. bool api_hal_power_deep_available();
  36. /** Go to sleep */
  37. void api_hal_power_sleep();
  38. /** Get predicted remaining battery capacity in percents */
  39. uint8_t api_hal_power_get_pct();
  40. /** Get battery health state in percents */
  41. uint8_t api_hal_power_get_bat_health_pct();
  42. /** Get charging status */
  43. bool api_hal_power_is_charging();
  44. /** Poweroff system */
  45. void api_hal_power_off();
  46. /** OTG enable */
  47. void api_hal_power_enable_otg();
  48. /** OTG disable */
  49. void api_hal_power_disable_otg();
  50. /** Get remaining battery battery capacity in mAh */
  51. uint32_t api_hal_power_get_battery_remaining_capacity();
  52. /** Get full charge battery capacity in mAh */
  53. uint32_t api_hal_power_get_battery_full_capacity();
  54. /** Get battery voltage in V */
  55. float api_hal_power_get_battery_voltage(ApiHalPowerIC ic);
  56. /** Get battery current in A */
  57. float api_hal_power_get_battery_current(ApiHalPowerIC ic);
  58. /** Get temperature in C */
  59. float api_hal_power_get_battery_temperature(ApiHalPowerIC ic);
  60. /** Get System voltage in V */
  61. float api_hal_power_get_system_voltage();
  62. /** Get USB voltage in V */
  63. float api_hal_power_get_usb_voltage();
  64. /** Get power system component state */
  65. void api_hal_power_dump_state(string_t buffer);
  66. /** Enable 3.3v on external gpio and sd card */
  67. void api_hal_power_enable_external_3_3v();
  68. /** Disable 3.3v on external gpio and sd card */
  69. void api_hal_power_disable_external_3_3v();
  70. #ifdef __cplusplus
  71. }
  72. #endif