ESP32_RTOS_SDK V1.1.0

- Main Page
- Modules
- Data Structures
- Files

Data Structures | Enumerations | Functions
Boot APIs
System APIs

boot APIs More...

## Data Structures

struct | b_info

## Enumerations

enum | flash_size { FLASH_SIZE_1MB = 0, FLASH_SIZE_2MB, FLASH_SIZE_4MB, FLASH_SIZE_8MB, FLASH_SIZE_16MB, FLASH_SIZE_MAX }

## Functions

enum flash_size | system_get_flash_size (void)
| Get the current Flash size. More...
uint8 | system_get_cpu_freq (void)
| Get CPU frequency. More...
bool | system_get_bin_info (uint8 bin_id, struct b_info *b_if)
| Get bin info named by b_id. More...
bool | system_set_bin_info (uint8 bin_id, struct b_info *b_if)
| Set bin info named by b_id. More...
uint8 | system_get_current_bin_id (void)
| Get current bin's bin_id. More...
bool | system_reboot_to_userbin (uint8 bin_id)
| reboot and jump to bin named by bin_id More...

## Detailed Description

boot APIs

## Enumeration Type Documentation

enum flash_size

Enumerator
FLASH_SIZE_1MB | Flash size : 1M Bytes
FLASH_SIZE_2MB | Flash size : 2M Bytes
FLASH_SIZE_4MB | Flash size : 4M Bytes
FLASH_SIZE_8MB | Flash size : 8M Bytes
FLASH_SIZE_16MB | Flash size : 16M Bytes

## Function Documentation

bool system_get_bin_info | ( | uint8 | bin_id,
|  | struct b_info * | b_if
| ) |  |

Get bin info named by b_id.

Parameters

  uint8 | bin_id : b_id number, must < 5
  struct | b_info *b_if : bin info of bin named by b_id

Returns
  true : succeed
  false : fail

uint8 system_get_cpu_freq | ( | void |  | ) |

Get CPU frequency.

Parameters

  null |

Returns
  CPU frequency, unit : MHz.

uint8 system_get_current_bin_id | ( | void |  | ) |

Get current bin's bin_id.

Parameters

  uint8 | bin_id : b_id number, must < 5

Returns
  uint8 type b_id

enum flash_size system_get_flash_size | ( | void |  | ) |

Get the current Flash size.

Parameters

  null |

Returns
  enum flash_size

bool system_reboot_to_userbin | ( | uint8 | bin_id | ) |

reboot and jump to bin named by bin_id

Parameters

  uint8 | bin_id : b_id number, must < 5

Returns
  true : succeed
  false : fail

bool system_set_bin_info | ( | uint8 | bin_id,
|  | struct b_info * | b_if
| ) |  |

Set bin info named by b_id.

Parameters

  uint8 | bin_id : b_id number, must < 5
  struct | b_info *b_if : bin info of bin named by b_id

Returns
  true : succeed
  false : fail