OVMS3-idf/components/esp32/include/esp_system.h

191 lines
6.4 KiB
C
Raw Normal View History

2016-08-17 15:08:22 +00:00
// Copyright 2015-2016 Espressif Systems (Shanghai) PTE LTD
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
#ifndef __ESP_SYSTEM_H__
#define __ESP_SYSTEM_H__
#include <stdint.h>
#include <stdbool.h>
#include "esp_err.h"
2016-12-13 05:23:04 +00:00
#include "esp_deep_sleep.h"
2016-08-17 15:08:22 +00:00
#ifdef __cplusplus
extern "C" {
#endif
typedef enum {
ESP_MAC_WIFI_STA,
ESP_MAC_WIFI_SOFTAP,
ESP_MAC_BT,
ESP_MAC_ETH,
} esp_mac_type_t;
#define TWO_MAC_ADDRESS_FROM_EFUSE 2
#define FOUR_MAC_ADDRESS_FROM_EFUSE 4
#define NUM_MAC_ADDRESS_FROM_EFUSE CONFIG_NUMBER_OF_MAC_ADDRESS_GENERATED_FROM_EFUSE
/**
* @attention application don't need to call this function anymore. It do nothing and will
* be removed in future version.
*/
void system_init(void) __attribute__ ((deprecated));
2016-08-17 15:08:22 +00:00
/**
2016-11-21 09:15:37 +00:00
* @brief Reset to default settings.
2016-08-17 15:08:22 +00:00
*
2016-11-21 09:15:37 +00:00
* Function has been deprecated, please use esp_wifi_restore instead.
* This name will be removed in a future release.
2016-08-17 15:08:22 +00:00
*/
2016-11-21 09:15:37 +00:00
void system_restore(void) __attribute__ ((deprecated));
2016-08-17 15:08:22 +00:00
/**
2016-11-21 09:15:37 +00:00
* @brief Restart PRO and APP CPUs.
2016-08-17 15:08:22 +00:00
*
2016-11-21 09:15:37 +00:00
* This function can be called both from PRO and APP CPUs.
* After successful restart, CPU reset reason will be SW_CPU_RESET.
* Peripherals (except for WiFi, BT, UART0, SPI1, and legacy timers) are not reset.
* This function does not return.
2016-08-17 15:08:22 +00:00
*/
2016-11-21 09:15:37 +00:00
void esp_restart(void) __attribute__ ((noreturn));
2016-08-17 15:08:22 +00:00
/**
* @brief Restart system.
*
2016-11-21 09:15:37 +00:00
* Function has been renamed to esp_restart.
* This name will be removed in a future release.
2016-08-17 15:08:22 +00:00
*/
void system_restart(void) __attribute__ ((deprecated, noreturn));
2016-08-17 15:08:22 +00:00
/**
* @brief Get system time, unit: microsecond.
*
2016-11-21 09:15:37 +00:00
* This function is deprecated. Use 'gettimeofday' function for 64-bit precision.
* This definition will be removed in a future release.
2016-08-17 15:08:22 +00:00
*/
2016-11-21 09:15:37 +00:00
uint32_t system_get_time(void) __attribute__ ((deprecated));
2016-08-17 15:08:22 +00:00
/**
* @brief Get the size of available heap.
*
2016-11-21 09:15:37 +00:00
* Note that the returned value may be larger than the maximum contiguous block
* which can be allocated.
2016-08-17 15:08:22 +00:00
*
2016-11-21 09:15:37 +00:00
* @return Available heap size, in bytes.
2016-08-17 15:08:22 +00:00
*/
2016-11-21 09:15:37 +00:00
uint32_t esp_get_free_heap_size(void);
2016-08-17 15:08:22 +00:00
/**
2016-11-21 09:15:37 +00:00
* @brief Get the size of available heap.
2016-08-17 15:08:22 +00:00
*
2016-11-21 09:15:37 +00:00
* Function has been renamed to esp_get_free_heap_size.
* This name will be removed in a future release.
2016-08-17 15:08:22 +00:00
*
2016-11-21 09:15:37 +00:00
* @return Available heap size, in bytes.
2016-08-17 15:08:22 +00:00
*/
2016-11-21 09:15:37 +00:00
uint32_t system_get_free_heap_size(void) __attribute__ ((deprecated));
2016-08-17 15:08:22 +00:00
/**
2016-11-21 09:15:37 +00:00
* @brief Get one random 32-bit word from hardware RNG
*
* @return random value between 0 and UINT32_MAX
*/
uint32_t esp_random(void);
2016-08-17 15:08:22 +00:00
/**
2016-11-21 09:15:37 +00:00
* @brief Read hardware MAC address.
2016-08-17 15:08:22 +00:00
*
* In WiFi MAC, only ESP32 station MAC is the hardware MAC, ESP32 softAP MAC is a software MAC
* calculated from ESP32 station MAC.
2016-11-21 09:15:37 +00:00
* So users need to call esp_wifi_get_macaddr to query the ESP32 softAP MAC if ESP32 station MAC changed.
2016-08-17 15:08:22 +00:00
*
2016-11-21 09:15:37 +00:00
* @param mac hardware MAC address, length: 6 bytes.
*
* @return ESP_OK on success
2016-08-17 15:08:22 +00:00
*/
esp_err_t esp_efuse_read_mac(uint8_t* mac);
2016-08-17 15:08:22 +00:00
/**
* @brief Read hardware MAC address.
*
2016-11-21 09:15:37 +00:00
* Function has been renamed to esp_efuse_read_mac.
* This name will be removed in a future release.
2016-08-17 15:08:22 +00:00
*
2016-11-21 09:15:37 +00:00
* @param mac hardware MAC address, length: 6 bytes.
* @return ESP_OK on success
2016-08-17 15:08:22 +00:00
*/
2016-11-21 09:15:37 +00:00
esp_err_t system_efuse_read_mac(uint8_t mac[6]) __attribute__ ((deprecated));
2016-08-17 15:08:22 +00:00
/**
* @brief Read hardware MAC address and set MAC address of the interface.
*
* This function first reads hardware MAC address from efuse. Then set the MAC address of the interface
* including wifi station, wifi softap, bluetooth and ethernet.
*
* @param mac MAC address of the interface, length: 6 bytes.
* @param type type of MAC address, 0:wifi station, 1:wifi softap, 2:bluetooth, 3:ethernet.
*
* @return ESP_OK on success
*/
esp_err_t esp_read_mac(uint8_t* mac, esp_mac_type_t type);
/**
* @brief Derive MAC address.
*
* This function derives a local MAC address from an universal MAC address.
* Addresses can either be universally administered addresses or locally administered addresses.
* A universally administered address is uniquely assigned to a device by its manufacturer.
* The first three octets (in transmission order) identify the organization that issued the identifier
* and are known as the Organizationally Unique Identifier (OUI).[4] The remainder of the address
* (three octets for MAC-48 and EUI-48 or five for EUI-64) are assigned by that organization in nearly
* any manner they please, subject to the constraint of uniqueness. A locally administered address is
* assigned to a device by a network administrator, overriding the burned-in address.
* Universally administered and locally administered addresses are distinguished by setting
* the second-least-significant bit of the first octet of the address. This bit is also referred to
* as the U/L bit, short for Universal/Local, which identifies how the address is administered.
* If the bit is 0, the address is universally administered. If it is 1, the address is locally administered.
* In the example address 06-00-00-00-00-00 the first octet is 06 (hex), the binary form of which is 00000110,
* where the second-least-significant bit is 1. Therefore, it is a locally administered address.[7] Consequently,
* this bit is 0 in all OUIs.
* In ESP32, universal MAC address is generated from the hardware MAC address in efuse.
* Local MAC address is derived from the universal MAC address.
*
* @param dst_mac Derived local MAC address, length: 6 bytes.
* @param src_mac Source universal MAC address, length: 6 bytes.
*
* @return ESP_OK on success
*/
esp_err_t esp_derive_mac(uint8_t* dst_mac, const uint8_t* src_mac);
/**
* Get SDK version
*
* This function is deprecated and will be removed in a future release.
*
* @return constant string "master"
*/
const char* system_get_sdk_version(void) __attribute__ ((deprecated));
2017-01-17 08:52:42 +00:00
/**
* Get IDF version
*
* @return constant string from IDF_VER
*/
const char* esp_get_idf_version(void);
2016-08-17 15:08:22 +00:00
#ifdef __cplusplus
}
#endif
#endif /* __ESP_SYSTEM_H__ */