From b2f390df01fbf50a27add10a4fed7e95c5e3e216 Mon Sep 17 00:00:00 2001 From: Marius Vikhammer Date: Fri, 11 Sep 2020 15:48:08 +0800 Subject: [PATCH] hal: update link to HAL readme.md The HAL readme was moved during refactoring, but links were not updated. --- components/hal/esp32/include/hal/adc_hal.h | 2 +- components/hal/esp32/include/hal/can_hal.h | 4 ++-- components/hal/esp32/include/hal/can_ll.h | 2 +- components/hal/esp32/include/hal/dac_ll.h | 2 +- components/hal/esp32/include/hal/gpio_ll.h | 2 +- components/hal/esp32/include/hal/i2s_ll.h | 2 +- components/hal/esp32/include/hal/mcpwm_ll.h | 2 +- components/hal/esp32/include/hal/pcnt_ll.h | 2 +- components/hal/esp32/include/hal/rtc_io_ll.h | 2 +- .../hal/esp32/include/hal/sigmadelta_ll.h | 2 +- .../hal/esp32/include/hal/spi_flash_ll.h | 2 +- components/hal/esp32/include/hal/spi_ll.h | 2 +- .../hal/esp32/include/hal/touch_sensor_hal.h | 2 +- .../hal/esp32/include/hal/touch_sensor_ll.h | 2 +- components/hal/esp32/include/hal/twai_ll.h | 14 ++++++------- components/hal/esp32s2/include/hal/adc_hal.h | 2 +- components/hal/esp32s2/include/hal/dac_ll.h | 4 ++-- components/hal/esp32s2/include/hal/gpio_ll.h | 2 +- .../hal/esp32s2/include/hal/gpspi_flash_ll.h | 2 +- components/hal/esp32s2/include/hal/i2s_ll.h | 2 +- components/hal/esp32s2/include/hal/pcnt_ll.h | 2 +- .../hal/esp32s2/include/hal/rtc_io_ll.h | 2 +- .../hal/esp32s2/include/hal/sigmadelta_ll.h | 2 +- .../hal/esp32s2/include/hal/spi_flash_ll.h | 2 +- components/hal/esp32s2/include/hal/spi_ll.h | 2 +- .../hal/esp32s2/include/hal/spimem_flash_ll.h | 2 +- .../esp32s2/include/hal/touch_sensor_hal.h | 2 +- .../hal/esp32s2/include/hal/touch_sensor_ll.h | 2 +- components/hal/esp32s2/include/hal/twai_ll.h | 14 ++++++------- components/hal/esp32s3/include/hal/adc_hal.h | 2 +- components/hal/esp32s3/include/hal/dac_ll.h | 2 +- components/hal/esp32s3/include/hal/gpio_ll.h | 2 +- .../hal/esp32s3/include/hal/gpspi_flash_ll.h | 2 +- components/hal/esp32s3/include/hal/i2s_ll.h | 2 +- components/hal/esp32s3/include/hal/mcpwm_ll.h | 2 +- components/hal/esp32s3/include/hal/pcnt_ll.h | 2 +- .../hal/esp32s3/include/hal/rtc_io_ll.h | 2 +- .../hal/esp32s3/include/hal/sigmadelta_ll.h | 2 +- .../hal/esp32s3/include/hal/spi_flash_ll.h | 2 +- components/hal/esp32s3/include/hal/spi_ll.h | 2 +- .../hal/esp32s3/include/hal/spimem_flash_ll.h | 2 +- .../esp32s3/include/hal/touch_sensor_hal.h | 2 +- .../hal/esp32s3/include/hal/touch_sensor_ll.h | 2 +- components/hal/esp32s3/include/hal/twai_ll.h | 12 +++++------ components/hal/include/hal/brownout_hal.h | 2 +- components/hal/include/hal/dac_hal.h | 2 +- components/hal/include/hal/gpio_hal.h | 14 ++++++------- components/hal/include/hal/i2c_hal.h | 20 +++++++++---------- components/hal/include/hal/i2s_hal.h | 2 +- components/hal/include/hal/ledc_hal.h | 2 +- components/hal/include/hal/mcpwm_hal.h | 2 +- components/hal/include/hal/pcnt_hal.h | 2 +- components/hal/include/hal/rtc_io_hal.h | 2 +- components/hal/include/hal/sdio_slave_hal.h | 2 +- components/hal/include/hal/sdio_slave_ll.h | 2 +- components/hal/include/hal/sigmadelta_hal.h | 2 +- components/hal/include/hal/spi_flash_hal.h | 2 +- components/hal/include/hal/spi_hal.h | 2 +- components/hal/include/hal/spi_slave_hal.h | 2 +- components/hal/include/hal/spi_slave_hd_hal.h | 2 +- components/hal/include/hal/timer_hal.h | 2 +- components/hal/include/hal/touch_sensor_hal.h | 2 +- components/hal/include/hal/twai_hal.h | 6 +++--- components/hal/include/hal/uart_hal.h | 2 +- components/hal/include/hal/wdt_hal.h | 2 +- components/soc/README.md | 4 ++-- .../soc/src/esp32s2/include/hal/dac_hal.h | 2 +- .../spi_flash/include/memspi_host_driver.h | 2 +- 68 files changed, 105 insertions(+), 105 deletions(-) diff --git a/components/hal/esp32/include/hal/adc_hal.h b/components/hal/esp32/include/hal/adc_hal.h index 4755054408..37200a19c9 100644 --- a/components/hal/esp32/include/hal/adc_hal.h +++ b/components/hal/esp32/include/hal/adc_hal.h @@ -15,7 +15,7 @@ /******************************************************************************* * NOTICE * The hal is not public api, don't use in application code. - * See readme.md in soc/include/hal/readme.md + * See readme.md in hal/include/hal/readme.md ******************************************************************************/ // The HAL layer for ADC (esp32 specific part) diff --git a/components/hal/esp32/include/hal/can_hal.h b/components/hal/esp32/include/hal/can_hal.h index fa587681bd..4a83d8d3ca 100644 --- a/components/hal/esp32/include/hal/can_hal.h +++ b/components/hal/esp32/include/hal/can_hal.h @@ -15,7 +15,7 @@ /******************************************************************************* * NOTICE * The hal is not public api, don't use in application code. - * See readme.md in soc/include/hal/readme.md + * See readme.md in hal/include/hal/readme.md ******************************************************************************/ #pragma once @@ -116,7 +116,7 @@ static inline uint32_t can_hal_decode_interrupt_events(can_hal_context_t *hal_ct static inline void can_hal_format_frame(const can_message_t *message, can_hal_frame_t *frame) { - twai_hal_format_frame(message, frame); + twai_hal_format_frame(message, frame); } static inline void can_hal_parse_frame(can_hal_frame_t *frame, can_message_t *message) diff --git a/components/hal/esp32/include/hal/can_ll.h b/components/hal/esp32/include/hal/can_ll.h index 5cbd10273d..0d0c8b2960 100644 --- a/components/hal/esp32/include/hal/can_ll.h +++ b/components/hal/esp32/include/hal/can_ll.h @@ -15,7 +15,7 @@ /******************************************************************************* * NOTICE * The ll is not public api, don't use in application code. - * See readme.md in soc/include/hal/readme.md + * See readme.md in hal/include/hal/readme.md ******************************************************************************/ // The Lowlevel layer for CAN diff --git a/components/hal/esp32/include/hal/dac_ll.h b/components/hal/esp32/include/hal/dac_ll.h index 3d1aa8e8eb..5ea4da8978 100644 --- a/components/hal/esp32/include/hal/dac_ll.h +++ b/components/hal/esp32/include/hal/dac_ll.h @@ -15,7 +15,7 @@ /******************************************************************************* * NOTICE * The ll is not public api, don't use in application code. - * See readme.md in soc/include/hal/readme.md + * See readme.md in hal/include/hal/readme.md ******************************************************************************/ #pragma once diff --git a/components/hal/esp32/include/hal/gpio_ll.h b/components/hal/esp32/include/hal/gpio_ll.h index 5fa8f5e680..d428fb3eab 100644 --- a/components/hal/esp32/include/hal/gpio_ll.h +++ b/components/hal/esp32/include/hal/gpio_ll.h @@ -15,7 +15,7 @@ /******************************************************************************* * NOTICE * The hal is not public api, don't use in application code. - * See readme.md in soc/include/hal/readme.md + * See readme.md in hal/include/hal/readme.md ******************************************************************************/ // The LL layer for ESP32 GPIO register operations diff --git a/components/hal/esp32/include/hal/i2s_ll.h b/components/hal/esp32/include/hal/i2s_ll.h index 703b92c785..5b7d93bed1 100644 --- a/components/hal/esp32/include/hal/i2s_ll.h +++ b/components/hal/esp32/include/hal/i2s_ll.h @@ -15,7 +15,7 @@ /******************************************************************************* * NOTICE * The hal is not public api, don't use in application code. - * See readme.md in soc/include/hal/readme.md + * See readme.md in hal/include/hal/readme.md ******************************************************************************/ // The LL layer for ESP32 I2S register operations diff --git a/components/hal/esp32/include/hal/mcpwm_ll.h b/components/hal/esp32/include/hal/mcpwm_ll.h index ef4afa9cca..6be08f26be 100644 --- a/components/hal/esp32/include/hal/mcpwm_ll.h +++ b/components/hal/esp32/include/hal/mcpwm_ll.h @@ -15,7 +15,7 @@ /******************************************************************************* * NOTICE * The hal is not public api, don't use in application code. - * See readme.md in soc/include/hal/readme.md + * See readme.md in hal/include/hal/readme.md ******************************************************************************/ // The LL layer for ESP32 MCPWM register operations diff --git a/components/hal/esp32/include/hal/pcnt_ll.h b/components/hal/esp32/include/hal/pcnt_ll.h index c1a2e55cb0..d0a5c12686 100644 --- a/components/hal/esp32/include/hal/pcnt_ll.h +++ b/components/hal/esp32/include/hal/pcnt_ll.h @@ -15,7 +15,7 @@ /******************************************************************************* * NOTICE * The hal is not public api, don't use in application code. - * See readme.md in soc/include/hal/readme.md + * See readme.md in hal/include/hal/readme.md ******************************************************************************/ // The LL layer for ESP32 PCNT register operations diff --git a/components/hal/esp32/include/hal/rtc_io_ll.h b/components/hal/esp32/include/hal/rtc_io_ll.h index 3a404299b6..9162464a1a 100644 --- a/components/hal/esp32/include/hal/rtc_io_ll.h +++ b/components/hal/esp32/include/hal/rtc_io_ll.h @@ -15,7 +15,7 @@ /******************************************************************************* * NOTICE * The ll is not public api, don't use in application code. - * See readme.md in soc/include/hal/readme.md + * See readme.md in hal/include/hal/readme.md ******************************************************************************/ #pragma once diff --git a/components/hal/esp32/include/hal/sigmadelta_ll.h b/components/hal/esp32/include/hal/sigmadelta_ll.h index 922cbc85ee..2e605ee594 100644 --- a/components/hal/esp32/include/hal/sigmadelta_ll.h +++ b/components/hal/esp32/include/hal/sigmadelta_ll.h @@ -14,7 +14,7 @@ /******************************************************************************* * NOTICE * The hal is not public api, don't use in application code. - * See readme.md in soc/include/hal/readme.md + * See readme.md in hal/include/hal/readme.md ******************************************************************************/ // The LL layer for ESP32 SIGMADELTA register operations diff --git a/components/hal/esp32/include/hal/spi_flash_ll.h b/components/hal/esp32/include/hal/spi_flash_ll.h index 50a3d0d641..0b4db15943 100644 --- a/components/hal/esp32/include/hal/spi_flash_ll.h +++ b/components/hal/esp32/include/hal/spi_flash_ll.h @@ -15,7 +15,7 @@ /******************************************************************************* * NOTICE * The ll is not public api, don't use in application code. - * See readme.md in soc/include/hal/readme.md + * See readme.md in hal/include/hal/readme.md ******************************************************************************/ // The Lowlevel layer for SPI Flash diff --git a/components/hal/esp32/include/hal/spi_ll.h b/components/hal/esp32/include/hal/spi_ll.h index bfcc9e7360..73b8b01a6a 100644 --- a/components/hal/esp32/include/hal/spi_ll.h +++ b/components/hal/esp32/include/hal/spi_ll.h @@ -15,7 +15,7 @@ /******************************************************************************* * NOTICE * The hal is not public api, don't use in application code. - * See readme.md in soc/include/hal/readme.md + * See readme.md in hal/include/hal/readme.md ******************************************************************************/ // The LL layer for ESP32 SPI register operations diff --git a/components/hal/esp32/include/hal/touch_sensor_hal.h b/components/hal/esp32/include/hal/touch_sensor_hal.h index 09a25dafd8..276153022a 100644 --- a/components/hal/esp32/include/hal/touch_sensor_hal.h +++ b/components/hal/esp32/include/hal/touch_sensor_hal.h @@ -15,7 +15,7 @@ /******************************************************************************* * NOTICE * The hal is not public api, don't use in application code. - * See readme.md in soc/include/hal/readme.md + * See readme.md in hal/include/hal/readme.md ******************************************************************************/ // The HAL layer for touch sensor (esp32 specific part) diff --git a/components/hal/esp32/include/hal/touch_sensor_ll.h b/components/hal/esp32/include/hal/touch_sensor_ll.h index a2a6711b3d..4016d4f566 100644 --- a/components/hal/esp32/include/hal/touch_sensor_ll.h +++ b/components/hal/esp32/include/hal/touch_sensor_ll.h @@ -15,7 +15,7 @@ /******************************************************************************* * NOTICE * The ll is not public api, don't use in application code. - * See readme.md in soc/include/hal/readme.md + * See readme.md in hal/include/hal/readme.md ******************************************************************************/ // The Lowlevel layer for Touch Sensor diff --git a/components/hal/esp32/include/hal/twai_ll.h b/components/hal/esp32/include/hal/twai_ll.h index 4c61140641..c02d2388f6 100644 --- a/components/hal/esp32/include/hal/twai_ll.h +++ b/components/hal/esp32/include/hal/twai_ll.h @@ -15,7 +15,7 @@ /******************************************************************************* * NOTICE * The ll is not public api, don't use in application code. - * See readme.md in soc/include/hal/readme.md + * See readme.md in hal/include/hal/readme.md ******************************************************************************/ // The Lowlevel layer for TWAI @@ -34,7 +34,7 @@ extern "C" { /* ------------------------- Defines and Typedefs --------------------------- */ -#define TWAI_LL_STATUS_RBS (0x1 << 0) //Receive Buffer Status +#define TWAI_LL_STATUS_RBS (0x1 << 0) //Receive Buffer Status #define TWAI_LL_STATUS_DOS (0x1 << 1) //Data Overrun Status #define TWAI_LL_STATUS_TBS (0x1 << 2) //Transmit Buffer Status #define TWAI_LL_STATUS_TCS (0x1 << 3) //Transmission Complete Status @@ -131,10 +131,10 @@ static inline bool twai_ll_is_in_reset_mode(twai_dev_t *hw) /** * @brief Set operating mode of TWAI controller - * + * * @param hw Start address of the TWAI registers * @param mode Operating mode - * + * * @note Must be called in reset mode */ static inline void twai_ll_set_mode(twai_dev_t *hw, twai_mode_t mode) @@ -546,7 +546,7 @@ static inline void twai_ll_get_rx_buffer(twai_dev_t *hw, twai_ll_frame_buffer_t * This function encodes a message into a frame structure. The frame structure * has an identical layout to the TX buffer, allowing the frame structure to be * directly copied into TX buffer. - * + * * @param[in] 11bit or 29bit ID * @param[in] dlc Data length code * @param[in] data Pointer to an 8 byte array containing data. NULL if no data @@ -655,9 +655,9 @@ static inline uint32_t twai_ll_get_rx_msg_count(twai_dev_t *hw) /** * @brief Set CLKOUT Divider and enable/disable - * + * * Configure CLKOUT. CLKOUT is a pre-scaled version of APB CLK. Divider can be - * 1, or any even number from 2 to 14. Set the divider to 0 to disable CLKOUT. + * 1, or any even number from 2 to 14. Set the divider to 0 to disable CLKOUT. * * @param hw Start address of the TWAI registers * @param divider Divider for CLKOUT. Set to 0 to disable CLKOUT diff --git a/components/hal/esp32s2/include/hal/adc_hal.h b/components/hal/esp32s2/include/hal/adc_hal.h index af552949fc..376c4fab2c 100644 --- a/components/hal/esp32s2/include/hal/adc_hal.h +++ b/components/hal/esp32s2/include/hal/adc_hal.h @@ -15,7 +15,7 @@ /******************************************************************************* * NOTICE * The hal is not public api, don't use in application code. - * See readme.md in soc/include/hal/readme.md + * See readme.md in hal/include/hal/readme.md ******************************************************************************/ // The HAL layer for ADC (esp32s2 specific part) diff --git a/components/hal/esp32s2/include/hal/dac_ll.h b/components/hal/esp32s2/include/hal/dac_ll.h index 7d24cdce89..c84ff70914 100644 --- a/components/hal/esp32s2/include/hal/dac_ll.h +++ b/components/hal/esp32s2/include/hal/dac_ll.h @@ -15,7 +15,7 @@ /******************************************************************************* * NOTICE * The ll is not public api, don't use in application code. - * See readme.md in soc/include/hal/readme.md + * See readme.md in hal/include/hal/readme.md ******************************************************************************/ #pragma once @@ -211,7 +211,7 @@ static inline void dac_ll_cw_set_dc_offset(dac_channel_t channel, int8_t offset) /** * Enable/disable invert the DAC digital controller clock signal. - * + * * @param enable true or false. */ static inline void dac_ll_digi_clk_inv(bool enable) diff --git a/components/hal/esp32s2/include/hal/gpio_ll.h b/components/hal/esp32s2/include/hal/gpio_ll.h index 3f83f77bf7..9fa745d8c9 100644 --- a/components/hal/esp32s2/include/hal/gpio_ll.h +++ b/components/hal/esp32s2/include/hal/gpio_ll.h @@ -15,7 +15,7 @@ /******************************************************************************* * NOTICE * The hal is not public api, don't use in application code. - * See readme.md in soc/include/hal/readme.md + * See readme.md in hal/include/hal/readme.md ******************************************************************************/ // The LL layer for ESP32-S2 GPIO register operations diff --git a/components/hal/esp32s2/include/hal/gpspi_flash_ll.h b/components/hal/esp32s2/include/hal/gpspi_flash_ll.h index 2db7e6fc4a..f9cf4e2633 100644 --- a/components/hal/esp32s2/include/hal/gpspi_flash_ll.h +++ b/components/hal/esp32s2/include/hal/gpspi_flash_ll.h @@ -15,7 +15,7 @@ /******************************************************************************* * NOTICE * The ll is not public api, don't use in application code. - * See readme.md in soc/include/hal/readme.md + * See readme.md in hal/include/hal/readme.md ******************************************************************************/ // The Lowlevel layer for SPI Flash diff --git a/components/hal/esp32s2/include/hal/i2s_ll.h b/components/hal/esp32s2/include/hal/i2s_ll.h index 4fe18da223..3e0a7eeb20 100644 --- a/components/hal/esp32s2/include/hal/i2s_ll.h +++ b/components/hal/esp32s2/include/hal/i2s_ll.h @@ -15,7 +15,7 @@ /******************************************************************************* * NOTICE * The hal is not public api, don't use in application code. - * See readme.md in soc/include/hal/readme.md + * See readme.md in hal/include/hal/readme.md ******************************************************************************/ // The LL layer for ESP32-S2 I2S register operations diff --git a/components/hal/esp32s2/include/hal/pcnt_ll.h b/components/hal/esp32s2/include/hal/pcnt_ll.h index 41fad9bec4..73cecac8cb 100644 --- a/components/hal/esp32s2/include/hal/pcnt_ll.h +++ b/components/hal/esp32s2/include/hal/pcnt_ll.h @@ -15,7 +15,7 @@ /******************************************************************************* * NOTICE * The hal is not public api, don't use in application code. - * See readme.md in soc/include/hal/readme.md + * See readme.md in hal/include/hal/readme.md ******************************************************************************/ // The LL layer for ESP32-S2 PCNT register operations diff --git a/components/hal/esp32s2/include/hal/rtc_io_ll.h b/components/hal/esp32s2/include/hal/rtc_io_ll.h index c687915ec0..82b67ea834 100644 --- a/components/hal/esp32s2/include/hal/rtc_io_ll.h +++ b/components/hal/esp32s2/include/hal/rtc_io_ll.h @@ -15,7 +15,7 @@ /******************************************************************************* * NOTICE * The ll is not public api, don't use in application code. - * See readme.md in soc/include/hal/readme.md + * See readme.md in hal/include/hal/readme.md ******************************************************************************/ #pragma once diff --git a/components/hal/esp32s2/include/hal/sigmadelta_ll.h b/components/hal/esp32s2/include/hal/sigmadelta_ll.h index 71a1190e28..1ecbf441ba 100644 --- a/components/hal/esp32s2/include/hal/sigmadelta_ll.h +++ b/components/hal/esp32s2/include/hal/sigmadelta_ll.h @@ -14,7 +14,7 @@ /******************************************************************************* * NOTICE * The hal is not public api, don't use in application code. - * See readme.md in soc/include/hal/readme.md + * See readme.md in hal/include/hal/readme.md ******************************************************************************/ // The LL layer for ESP32-S2 SIGMADELTA register operations diff --git a/components/hal/esp32s2/include/hal/spi_flash_ll.h b/components/hal/esp32s2/include/hal/spi_flash_ll.h index d31bf2a50f..8cb6cf7f8a 100644 --- a/components/hal/esp32s2/include/hal/spi_flash_ll.h +++ b/components/hal/esp32s2/include/hal/spi_flash_ll.h @@ -15,7 +15,7 @@ /******************************************************************************* * NOTICE * The ll is not public api, don't use in application code. - * See readme.md in soc/include/hal/readme.md + * See readme.md in hal/include/hal/readme.md ******************************************************************************/ // The Lowlevel layer for SPI Flash diff --git a/components/hal/esp32s2/include/hal/spi_ll.h b/components/hal/esp32s2/include/hal/spi_ll.h index cc3a3ded5a..ca8f685c71 100644 --- a/components/hal/esp32s2/include/hal/spi_ll.h +++ b/components/hal/esp32s2/include/hal/spi_ll.h @@ -15,7 +15,7 @@ /******************************************************************************* * NOTICE * The hal is not public api, don't use in application code. - * See readme.md in soc/include/hal/readme.md + * See readme.md in hal/include/hal/readme.md ******************************************************************************/ // The LL layer for ESP32-S2 SPI register operations diff --git a/components/hal/esp32s2/include/hal/spimem_flash_ll.h b/components/hal/esp32s2/include/hal/spimem_flash_ll.h index d5a0e26a09..ced88ab2e5 100644 --- a/components/hal/esp32s2/include/hal/spimem_flash_ll.h +++ b/components/hal/esp32s2/include/hal/spimem_flash_ll.h @@ -15,7 +15,7 @@ /******************************************************************************* * NOTICE * The ll is not public api, don't use in application code. - * See readme.md in soc/include/hal/readme.md + * See readme.md in hal/include/hal/readme.md ******************************************************************************/ // The Lowlevel layer for SPI Flash diff --git a/components/hal/esp32s2/include/hal/touch_sensor_hal.h b/components/hal/esp32s2/include/hal/touch_sensor_hal.h index 4c984a3589..f755924d55 100644 --- a/components/hal/esp32s2/include/hal/touch_sensor_hal.h +++ b/components/hal/esp32s2/include/hal/touch_sensor_hal.h @@ -15,7 +15,7 @@ /******************************************************************************* * NOTICE * The hal is not public api, don't use in application code. - * See readme.md in soc/include/hal/readme.md + * See readme.md in hal/include/hal/readme.md ******************************************************************************/ // The HAL layer for touch sensor (esp32s2 specific part) diff --git a/components/hal/esp32s2/include/hal/touch_sensor_ll.h b/components/hal/esp32s2/include/hal/touch_sensor_ll.h index 76a64dcfa6..a287a07c78 100644 --- a/components/hal/esp32s2/include/hal/touch_sensor_ll.h +++ b/components/hal/esp32s2/include/hal/touch_sensor_ll.h @@ -15,7 +15,7 @@ /******************************************************************************* * NOTICE * The ll is not public api, don't use in application code. - * See readme.md in soc/include/hal/readme.md + * See readme.md in hal/include/hal/readme.md ******************************************************************************/ // The Lowlevel layer for Touch Sensor diff --git a/components/hal/esp32s2/include/hal/twai_ll.h b/components/hal/esp32s2/include/hal/twai_ll.h index 5291dd4ae3..f3c03d9829 100644 --- a/components/hal/esp32s2/include/hal/twai_ll.h +++ b/components/hal/esp32s2/include/hal/twai_ll.h @@ -15,7 +15,7 @@ /******************************************************************************* * NOTICE * The ll is not public api, don't use in application code. - * See readme.md in soc/include/hal/readme.md + * See readme.md in hal/include/hal/readme.md ******************************************************************************/ // The Lowlevel layer for TWAI @@ -33,7 +33,7 @@ extern "C" { /* ------------------------- Defines and Typedefs --------------------------- */ -#define TWAI_LL_STATUS_RBS (0x1 << 0) //Receive Buffer Status +#define TWAI_LL_STATUS_RBS (0x1 << 0) //Receive Buffer Status #define TWAI_LL_STATUS_DOS (0x1 << 1) //Data Overrun Status #define TWAI_LL_STATUS_TBS (0x1 << 2) //Transmit Buffer Status #define TWAI_LL_STATUS_TCS (0x1 << 3) //Transmission Complete Status @@ -130,10 +130,10 @@ static inline bool twai_ll_is_in_reset_mode(twai_dev_t *hw) /** * @brief Set operating mode of TWAI controller - * + * * @param hw Start address of the TWAI registers * @param mode Operating mode - * + * * @note Must be called in reset mode */ static inline void twai_ll_set_mode(twai_dev_t *hw, twai_mode_t mode) @@ -530,7 +530,7 @@ static inline void twai_ll_get_rx_buffer(twai_dev_t *hw, twai_ll_frame_buffer_t * This function encodes a message into a frame structure. The frame structure * has an identical layout to the TX buffer, allowing the frame structure to be * directly copied into TX buffer. - * + * * @param[in] 11bit or 29bit ID * @param[in] dlc Data length code * @param[in] data Pointer to an 8 byte array containing data. NULL if no data @@ -641,8 +641,8 @@ static inline uint32_t twai_ll_get_rx_msg_count(twai_dev_t *hw) * @brief Set CLKOUT Divider and enable/disable * * Configure CLKOUT. CLKOUT is a pre-scaled version of APB CLK. Divider can be - * 1, or any even number from 2 to 490. Set the divider to 0 to disable CLKOUT. - * + * 1, or any even number from 2 to 490. Set the divider to 0 to disable CLKOUT. + * * @param hw Start address of the TWAI registers * @param divider Divider for CLKOUT (any even number from 2 to 490). Set to 0 to disable CLKOUT */ diff --git a/components/hal/esp32s3/include/hal/adc_hal.h b/components/hal/esp32s3/include/hal/adc_hal.h index 93ef05f017..7a07053e0c 100644 --- a/components/hal/esp32s3/include/hal/adc_hal.h +++ b/components/hal/esp32s3/include/hal/adc_hal.h @@ -15,7 +15,7 @@ /******************************************************************************* * NOTICE * The hal is not public api, don't use in application code. - * See readme.md in soc/include/hal/readme.md + * See readme.md in hal/include/hal/readme.md ******************************************************************************/ // The HAL layer for ADC (esp32s3 specific part) diff --git a/components/hal/esp32s3/include/hal/dac_ll.h b/components/hal/esp32s3/include/hal/dac_ll.h index 04cb247a6b..7e5f3621b0 100644 --- a/components/hal/esp32s3/include/hal/dac_ll.h +++ b/components/hal/esp32s3/include/hal/dac_ll.h @@ -15,7 +15,7 @@ /******************************************************************************* * NOTICE * The ll is not public api, don't use in application code. - * See readme.md in soc/include/hal/readme.md + * See readme.md in hal/include/hal/readme.md ******************************************************************************/ #pragma once diff --git a/components/hal/esp32s3/include/hal/gpio_ll.h b/components/hal/esp32s3/include/hal/gpio_ll.h index 11cc4b69f1..3a9b48ca0f 100644 --- a/components/hal/esp32s3/include/hal/gpio_ll.h +++ b/components/hal/esp32s3/include/hal/gpio_ll.h @@ -15,7 +15,7 @@ /******************************************************************************* * NOTICE * The hal is not public api, don't use in application code. - * See readme.md in soc/include/hal/readme.md + * See readme.md in hal/include/hal/readme.md ******************************************************************************/ // The LL layer for ESP32-S3 GPIO register operations diff --git a/components/hal/esp32s3/include/hal/gpspi_flash_ll.h b/components/hal/esp32s3/include/hal/gpspi_flash_ll.h index 4d58b60c91..3b4b70ecb3 100644 --- a/components/hal/esp32s3/include/hal/gpspi_flash_ll.h +++ b/components/hal/esp32s3/include/hal/gpspi_flash_ll.h @@ -15,7 +15,7 @@ /******************************************************************************* * NOTICE * The ll is not public api, don't use in application code. - * See readme.md in soc/include/hal/readme.md + * See readme.md in hal/include/hal/readme.md ******************************************************************************/ // The Lowlevel layer for SPI Flash diff --git a/components/hal/esp32s3/include/hal/i2s_ll.h b/components/hal/esp32s3/include/hal/i2s_ll.h index b71c27a21b..645e84793e 100644 --- a/components/hal/esp32s3/include/hal/i2s_ll.h +++ b/components/hal/esp32s3/include/hal/i2s_ll.h @@ -15,7 +15,7 @@ /******************************************************************************* * NOTICE * The hal is not public api, don't use in application code. - * See readme.md in soc/include/hal/readme.md + * See readme.md in hal/include/hal/readme.md ******************************************************************************/ // The LL layer for ESP32-S3 I2S register operations diff --git a/components/hal/esp32s3/include/hal/mcpwm_ll.h b/components/hal/esp32s3/include/hal/mcpwm_ll.h index b990675185..22c24af75c 100644 --- a/components/hal/esp32s3/include/hal/mcpwm_ll.h +++ b/components/hal/esp32s3/include/hal/mcpwm_ll.h @@ -15,7 +15,7 @@ /******************************************************************************* * NOTICE * The hal is not public api, don't use in application code. - * See readme.md in soc/include/hal/readme.md + * See readme.md in hal/include/hal/readme.md ******************************************************************************/ // The LL layer for ESP32 MCPWM register operations diff --git a/components/hal/esp32s3/include/hal/pcnt_ll.h b/components/hal/esp32s3/include/hal/pcnt_ll.h index c516b3ca24..376f17c268 100644 --- a/components/hal/esp32s3/include/hal/pcnt_ll.h +++ b/components/hal/esp32s3/include/hal/pcnt_ll.h @@ -15,7 +15,7 @@ /******************************************************************************* * NOTICE * The hal is not public api, don't use in application code. - * See readme.md in soc/include/hal/readme.md + * See readme.md in hal/include/hal/readme.md ******************************************************************************/ // The LL layer for ESP32-S3 PCNT register operations diff --git a/components/hal/esp32s3/include/hal/rtc_io_ll.h b/components/hal/esp32s3/include/hal/rtc_io_ll.h index ebb83ba659..5f6eb3c423 100644 --- a/components/hal/esp32s3/include/hal/rtc_io_ll.h +++ b/components/hal/esp32s3/include/hal/rtc_io_ll.h @@ -15,7 +15,7 @@ /******************************************************************************* * NOTICE * The ll is not public api, don't use in application code. - * See readme.md in soc/include/hal/readme.md + * See readme.md in hal/include/hal/readme.md ******************************************************************************/ #pragma once diff --git a/components/hal/esp32s3/include/hal/sigmadelta_ll.h b/components/hal/esp32s3/include/hal/sigmadelta_ll.h index 922cbc85ee..2e605ee594 100644 --- a/components/hal/esp32s3/include/hal/sigmadelta_ll.h +++ b/components/hal/esp32s3/include/hal/sigmadelta_ll.h @@ -14,7 +14,7 @@ /******************************************************************************* * NOTICE * The hal is not public api, don't use in application code. - * See readme.md in soc/include/hal/readme.md + * See readme.md in hal/include/hal/readme.md ******************************************************************************/ // The LL layer for ESP32 SIGMADELTA register operations diff --git a/components/hal/esp32s3/include/hal/spi_flash_ll.h b/components/hal/esp32s3/include/hal/spi_flash_ll.h index bdd06c2dcb..411058da81 100644 --- a/components/hal/esp32s3/include/hal/spi_flash_ll.h +++ b/components/hal/esp32s3/include/hal/spi_flash_ll.h @@ -15,7 +15,7 @@ /******************************************************************************* * NOTICE * The ll is not public api, don't use in application code. - * See readme.md in soc/include/hal/readme.md + * See readme.md in hal/include/hal/readme.md ******************************************************************************/ // The Lowlevel layer for SPI Flash diff --git a/components/hal/esp32s3/include/hal/spi_ll.h b/components/hal/esp32s3/include/hal/spi_ll.h index 133cac76ac..d7989c0fd7 100644 --- a/components/hal/esp32s3/include/hal/spi_ll.h +++ b/components/hal/esp32s3/include/hal/spi_ll.h @@ -15,7 +15,7 @@ /******************************************************************************* * NOTICE * The hal is not public api, don't use in application code. - * See readme.md in soc/include/hal/readme.md + * See readme.md in hal/include/hal/readme.md ******************************************************************************/ // The LL layer for ESP32-S3 SPI register operations diff --git a/components/hal/esp32s3/include/hal/spimem_flash_ll.h b/components/hal/esp32s3/include/hal/spimem_flash_ll.h index 40c4002633..d5a27a54f2 100644 --- a/components/hal/esp32s3/include/hal/spimem_flash_ll.h +++ b/components/hal/esp32s3/include/hal/spimem_flash_ll.h @@ -15,7 +15,7 @@ /******************************************************************************* * NOTICE * The ll is not public api, don't use in application code. - * See readme.md in soc/include/hal/readme.md + * See readme.md in hal/include/hal/readme.md ******************************************************************************/ // The Lowlevel layer for SPI Flash diff --git a/components/hal/esp32s3/include/hal/touch_sensor_hal.h b/components/hal/esp32s3/include/hal/touch_sensor_hal.h index 4c984a3589..f755924d55 100644 --- a/components/hal/esp32s3/include/hal/touch_sensor_hal.h +++ b/components/hal/esp32s3/include/hal/touch_sensor_hal.h @@ -15,7 +15,7 @@ /******************************************************************************* * NOTICE * The hal is not public api, don't use in application code. - * See readme.md in soc/include/hal/readme.md + * See readme.md in hal/include/hal/readme.md ******************************************************************************/ // The HAL layer for touch sensor (esp32s2 specific part) diff --git a/components/hal/esp32s3/include/hal/touch_sensor_ll.h b/components/hal/esp32s3/include/hal/touch_sensor_ll.h index 64f117aa09..8c4af7774c 100644 --- a/components/hal/esp32s3/include/hal/touch_sensor_ll.h +++ b/components/hal/esp32s3/include/hal/touch_sensor_ll.h @@ -15,7 +15,7 @@ /******************************************************************************* * NOTICE * The ll is not public api, don't use in application code. - * See readme.md in soc/include/hal/readme.md + * See readme.md in hal/include/hal/readme.md ******************************************************************************/ // The Lowlevel layer for Touch Sensor diff --git a/components/hal/esp32s3/include/hal/twai_ll.h b/components/hal/esp32s3/include/hal/twai_ll.h index 39ae0e0db8..68dae5130e 100644 --- a/components/hal/esp32s3/include/hal/twai_ll.h +++ b/components/hal/esp32s3/include/hal/twai_ll.h @@ -15,7 +15,7 @@ /******************************************************************************* * NOTICE * The ll is not public api, don't use in application code. - * See readme.md in soc/include/hal/readme.md + * See readme.md in hal/include/hal/readme.md ******************************************************************************/ // The Lowlevel layer for TWAI @@ -134,10 +134,10 @@ static inline bool twai_ll_is_in_reset_mode(twai_dev_t *hw) /** * @brief Set operating mode of TWAI controller - * + * * @param hw Start address of the TWAI registers * @param mode Operating mode - * + * * @note Must be called in reset mode */ static inline void twai_ll_set_mode(twai_dev_t *hw, twai_mode_t mode) @@ -551,7 +551,7 @@ static inline void twai_ll_get_rx_buffer(twai_dev_t *hw, twai_ll_frame_buffer_t * This function encodes a message into a frame structure. The frame structure * has an identical layout to the TX buffer, allowing the frame structure to be * directly copied into TX buffer. - * + * * @param[in] 11bit or 29bit ID * @param[in] dlc Data length code * @param[in] data Pointer to an 8 byte array containing data. NULL if no data @@ -660,9 +660,9 @@ static inline uint32_t twai_ll_get_rx_msg_count(twai_dev_t *hw) /** * @brief Set CLKOUT Divider and enable/disable - * + * * Configure CLKOUT. CLKOUT is a pre-scaled version of APB CLK. Divider can be - * 1, or any even number from 2 to 14. Set the divider to 0 to disable CLKOUT. + * 1, or any even number from 2 to 14. Set the divider to 0 to disable CLKOUT. * * @param hw Start address of the TWAI registers * @param divider Divider for CLKOUT. Set to 0 to disable CLKOUT diff --git a/components/hal/include/hal/brownout_hal.h b/components/hal/include/hal/brownout_hal.h index 97523fcc07..e2df945941 100644 --- a/components/hal/include/hal/brownout_hal.h +++ b/components/hal/include/hal/brownout_hal.h @@ -15,7 +15,7 @@ /******************************************************************************* * NOTICE * The hal is not public api, don't use in application code. - * See readme.md in soc/include/hal/readme.md + * See readme.md in hal/include/hal/readme.md ******************************************************************************/ #pragma once diff --git a/components/hal/include/hal/dac_hal.h b/components/hal/include/hal/dac_hal.h index a7c9fafd4e..04dccc5cd2 100644 --- a/components/hal/include/hal/dac_hal.h +++ b/components/hal/include/hal/dac_hal.h @@ -15,7 +15,7 @@ /******************************************************************************* * NOTICE * The hal is not public api, don't use in application code. - * See readme.md in soc/include/hal/readme.md + * See readme.md in hal/include/hal/readme.md ******************************************************************************/ #pragma once diff --git a/components/hal/include/hal/gpio_hal.h b/components/hal/include/hal/gpio_hal.h index 971496405a..ca4249321c 100644 --- a/components/hal/include/hal/gpio_hal.h +++ b/components/hal/include/hal/gpio_hal.h @@ -15,7 +15,7 @@ /******************************************************************************* * NOTICE * The hal is not public api, don't use in application code. - * See readme.md in soc/include/hal/readme.md + * See readme.md in hal/include/hal/readme.md ******************************************************************************/ // The HAL layer for GPIO @@ -321,17 +321,17 @@ void gpio_hal_intr_disable(gpio_hal_context_t *hal, gpio_num_t gpio_num); #if GPIO_SUPPORTS_FORCE_HOLD /** - * @brief Force hold digital and rtc gpio pad. - * @note GPIO force hold, whether the chip in sleep mode or wakeup mode. - * + * @brief Force hold digital and rtc gpio pad. + * @note GPIO force hold, whether the chip in sleep mode or wakeup mode. + * * @param hal Context of the HAL layer * */ #define gpio_hal_force_hold_all(hal) gpio_ll_force_hold_all((hal)->dev) /** - * @brief Force unhold digital and rtc gpio pad. - * @note GPIO force unhold, whether the chip in sleep mode or wakeup mode. - * + * @brief Force unhold digital and rtc gpio pad. + * @note GPIO force unhold, whether the chip in sleep mode or wakeup mode. + * * @param hal Context of the HAL layer * */ #define gpio_hal_force_unhold_all(hal) gpio_ll_force_unhold_all((hal)->dev) diff --git a/components/hal/include/hal/i2c_hal.h b/components/hal/include/hal/i2c_hal.h index 5b148e02ae..9e38d358df 100644 --- a/components/hal/include/hal/i2c_hal.h +++ b/components/hal/include/hal/i2c_hal.h @@ -15,7 +15,7 @@ /******************************************************************************* * NOTICE * The hal is not public api, don't use in application code. - * See readme.md in soc/include/hal/readme.md + * See readme.md in hal/include/hal/readme.md ******************************************************************************/ // The HAL layer for I2C @@ -75,7 +75,7 @@ typedef struct { #define i2c_hal_trans_start(hal) i2c_ll_trans_start((hal)->dev) /** - * @brief Enable I2C master RX interrupt + * @brief Enable I2C master RX interrupt * * @param hal Context of the HAL layer * @@ -84,7 +84,7 @@ typedef struct { #define i2c_hal_enable_master_rx_it(hal) i2c_ll_master_enable_rx_it((hal)->dev) /** - * @brief Enable I2C master TX interrupt + * @brief Enable I2C master TX interrupt * * @param hal Context of the HAL layer * @@ -458,7 +458,7 @@ void i2c_hal_master_fsm_rst(i2c_hal_context_t *hal); void i2c_hal_master_clr_bus(i2c_hal_context_t *hal); /** - * @brief Enable I2C slave TX interrupt + * @brief Enable I2C slave TX interrupt * * @param hal Context of the HAL layer * @@ -467,7 +467,7 @@ void i2c_hal_master_clr_bus(i2c_hal_context_t *hal); void i2c_hal_enable_slave_tx_it(i2c_hal_context_t *hal); /** - * @brief Disable I2C slave TX interrupt + * @brief Disable I2C slave TX interrupt * * @param hal Context of the HAL layer * @@ -476,7 +476,7 @@ void i2c_hal_enable_slave_tx_it(i2c_hal_context_t *hal); void i2c_hal_disable_slave_tx_it(i2c_hal_context_t *hal); /** - * @brief Enable I2C slave RX interrupt + * @brief Enable I2C slave RX interrupt * * @param hal Context of the HAL layer * @@ -485,7 +485,7 @@ void i2c_hal_disable_slave_tx_it(i2c_hal_context_t *hal); void i2c_hal_enable_slave_rx_it(i2c_hal_context_t *hal); /** - * @brief Disable I2C slave RX interrupt + * @brief Disable I2C slave RX interrupt * * @param hal Context of the HAL layer * @@ -494,7 +494,7 @@ void i2c_hal_enable_slave_rx_it(i2c_hal_context_t *hal); void i2c_hal_disable_slave_rx_it(i2c_hal_context_t *hal); /** - * @brief I2C master handle tx interrupt event + * @brief I2C master handle tx interrupt event * * @param hal Context of the HAL layer * @param event Pointer to accept the interrupt event @@ -504,7 +504,7 @@ void i2c_hal_disable_slave_rx_it(i2c_hal_context_t *hal); void i2c_hal_master_handle_tx_event(i2c_hal_context_t *hal, i2c_intr_event_t *event); /** - * @brief I2C master handle rx interrupt event + * @brief I2C master handle rx interrupt event * * @param hal Context of the HAL layer * @param event Pointer to accept the interrupt event @@ -514,7 +514,7 @@ void i2c_hal_master_handle_tx_event(i2c_hal_context_t *hal, i2c_intr_event_t *ev void i2c_hal_master_handle_rx_event(i2c_hal_context_t *hal, i2c_intr_event_t *event); /** - * @brief I2C slave handle interrupt event + * @brief I2C slave handle interrupt event * * @param hal Context of the HAL layer * @param event Pointer to accept the interrupt event diff --git a/components/hal/include/hal/i2s_hal.h b/components/hal/include/hal/i2s_hal.h index b3118fe89b..cff02d9896 100644 --- a/components/hal/include/hal/i2s_hal.h +++ b/components/hal/include/hal/i2s_hal.h @@ -15,7 +15,7 @@ /******************************************************************************* * NOTICE * The hal is not public api, don't use in application code. - * See readme.md in soc/include/hal/readme.md + * See readme.md in hal/include/hal/readme.md ******************************************************************************/ // The HAL layer for I2S. diff --git a/components/hal/include/hal/ledc_hal.h b/components/hal/include/hal/ledc_hal.h index 967e82674f..2afa547751 100644 --- a/components/hal/include/hal/ledc_hal.h +++ b/components/hal/include/hal/ledc_hal.h @@ -15,7 +15,7 @@ /******************************************************************************* * NOTICE * The hal is not public api, don't use in application code. - * See readme.md in soc/include/hal/readme.md + * See readme.md in hal/include/hal/readme.md ******************************************************************************/ // The HAL layer for LEDC. diff --git a/components/hal/include/hal/mcpwm_hal.h b/components/hal/include/hal/mcpwm_hal.h index 3b3f051d88..1d45b9dafa 100644 --- a/components/hal/include/hal/mcpwm_hal.h +++ b/components/hal/include/hal/mcpwm_hal.h @@ -15,7 +15,7 @@ /******************************************************************************* * NOTICE * The hal is not public api, don't use in application code. - * See readme.md in soc/include/hal/readme.md + * See readme.md in hal/include/hal/readme.md ******************************************************************************/ // The HAL layer for MCPWM (common part) diff --git a/components/hal/include/hal/pcnt_hal.h b/components/hal/include/hal/pcnt_hal.h index 2a14a0ae77..2a5972d8d7 100644 --- a/components/hal/include/hal/pcnt_hal.h +++ b/components/hal/include/hal/pcnt_hal.h @@ -15,7 +15,7 @@ /******************************************************************************* * NOTICE * The hal is not public api, don't use in application code. - * See readme.md in soc/include/hal/readme.md + * See readme.md in hal/include/hal/readme.md ******************************************************************************/ // The HAL layer for PCNT. diff --git a/components/hal/include/hal/rtc_io_hal.h b/components/hal/include/hal/rtc_io_hal.h index 8bf0d64c00..81e29721c8 100644 --- a/components/hal/include/hal/rtc_io_hal.h +++ b/components/hal/include/hal/rtc_io_hal.h @@ -15,7 +15,7 @@ /******************************************************************************* * NOTICE * The hal is not public api, don't use in application code. - * See readme.md in soc/include/hal/readme.md + * See readme.md in hal/include/hal/readme.md ******************************************************************************/ // The HAL layer for RTC IO master (common part) diff --git a/components/hal/include/hal/sdio_slave_hal.h b/components/hal/include/hal/sdio_slave_hal.h index e95bf045df..52975c5ec0 100644 --- a/components/hal/include/hal/sdio_slave_hal.h +++ b/components/hal/include/hal/sdio_slave_hal.h @@ -15,7 +15,7 @@ /******************************************************************************* * NOTICE * The hal is not public api, don't use in application code. - * See readme.md in soc/include/hal/readme.md + * See readme.md in hal/include/hal/readme.md ******************************************************************************/ // The HAL layer for SDIO slave (common part) diff --git a/components/hal/include/hal/sdio_slave_ll.h b/components/hal/include/hal/sdio_slave_ll.h index 129f288cad..e013f5f112 100644 --- a/components/hal/include/hal/sdio_slave_ll.h +++ b/components/hal/include/hal/sdio_slave_ll.h @@ -15,7 +15,7 @@ /******************************************************************************* * NOTICE * The hal is not public api, don't use in application code. - * See readme.md in soc/include/hal/readme.md + * See readme.md in hal/include/hal/readme.md ******************************************************************************/ // The LL layer for ESP32 SDIO slave register operations diff --git a/components/hal/include/hal/sigmadelta_hal.h b/components/hal/include/hal/sigmadelta_hal.h index 55363fdccf..58cb4c2180 100644 --- a/components/hal/include/hal/sigmadelta_hal.h +++ b/components/hal/include/hal/sigmadelta_hal.h @@ -15,7 +15,7 @@ /******************************************************************************* * NOTICE * The hal is not public api, don't use in application code. - * See readme.md in soc/include/hal/readme.md + * See readme.md in hal/include/hal/readme.md ******************************************************************************/ // The HAL layer for SIGMADELTA. diff --git a/components/hal/include/hal/spi_flash_hal.h b/components/hal/include/hal/spi_flash_hal.h index ffc1a22f03..6306294740 100644 --- a/components/hal/include/hal/spi_flash_hal.h +++ b/components/hal/include/hal/spi_flash_hal.h @@ -15,7 +15,7 @@ /******************************************************************************* * NOTICE * The HAL is not public api, don't use in application code. - * See readme.md in soc/include/hal/readme.md + * See readme.md in hal/include/hal/readme.md ******************************************************************************/ // The HAL layer for SPI Flash (common part) diff --git a/components/hal/include/hal/spi_hal.h b/components/hal/include/hal/spi_hal.h index 3324110baf..6f0aa024fb 100644 --- a/components/hal/include/hal/spi_hal.h +++ b/components/hal/include/hal/spi_hal.h @@ -15,7 +15,7 @@ /******************************************************************************* * NOTICE * The hal is not public api, don't use in application code. - * See readme.md in soc/include/hal/readme.md + * See readme.md in hal/include/hal/readme.md ******************************************************************************/ // The HAL layer for SPI master (common part) diff --git a/components/hal/include/hal/spi_slave_hal.h b/components/hal/include/hal/spi_slave_hal.h index 80e1113716..f8acf2d973 100644 --- a/components/hal/include/hal/spi_slave_hal.h +++ b/components/hal/include/hal/spi_slave_hal.h @@ -15,7 +15,7 @@ /******************************************************************************* * NOTICE * The hal is not public api, don't use in application code. - * See readme.md in soc/include/hal/readme.md + * See readme.md in hal/include/hal/readme.md ******************************************************************************/ // The HAL layer for SPI slave (common part) diff --git a/components/hal/include/hal/spi_slave_hd_hal.h b/components/hal/include/hal/spi_slave_hd_hal.h index c9e3684d7e..6e13e2c290 100644 --- a/components/hal/include/hal/spi_slave_hd_hal.h +++ b/components/hal/include/hal/spi_slave_hd_hal.h @@ -15,7 +15,7 @@ /******************************************************************************* * NOTICE * The hal is not public api, don't use in application code. - * See readme.md in soc/include/hal/readme.md + * See readme.md in hal/include/hal/readme.md ******************************************************************************/ /* diff --git a/components/hal/include/hal/timer_hal.h b/components/hal/include/hal/timer_hal.h index bf9ebffc1c..f9188fe3f1 100644 --- a/components/hal/include/hal/timer_hal.h +++ b/components/hal/include/hal/timer_hal.h @@ -15,7 +15,7 @@ /******************************************************************************* * NOTICE * The hal is not public api, don't use in application code. - * See readme.md in soc/include/hal/readme.md + * See readme.md in hal/include/hal/readme.md ******************************************************************************/ // The HAL layer for Timer Group. diff --git a/components/hal/include/hal/touch_sensor_hal.h b/components/hal/include/hal/touch_sensor_hal.h index a2ad36946c..98cdfc7916 100644 --- a/components/hal/include/hal/touch_sensor_hal.h +++ b/components/hal/include/hal/touch_sensor_hal.h @@ -15,7 +15,7 @@ /******************************************************************************* * NOTICE * The hal is not public api, don't use in application code. - * See readme.md in soc/include/hal/readme.md + * See readme.md in hal/include/hal/readme.md ******************************************************************************/ // The HAL layer for touch sensor (common part) diff --git a/components/hal/include/hal/twai_hal.h b/components/hal/include/hal/twai_hal.h index 13d49b95ef..6ba445555d 100644 --- a/components/hal/include/hal/twai_hal.h +++ b/components/hal/include/hal/twai_hal.h @@ -15,7 +15,7 @@ /******************************************************************************* * NOTICE * The hal is not public api, don't use in application code. - * See readme.md in soc/include/hal/readme.md + * See readme.md in hal/include/hal/readme.md ******************************************************************************/ #pragma once @@ -175,11 +175,11 @@ static inline bool twai_hal_check_last_tx_successful(twai_hal_context_t *hal_ctx /** * @brief Check if certain HAL state flags are set - * + * * The HAL will maintain a record of the controller's state via a set of flags. * These flags are automatically maintained (i.e., set and reset) inside various * HAL function calls. This function checks if certain flags are currently set. - * + * * @param hal_ctx Context of the HAL layer * @param check_flags Bit mask of flags to check * @return True if one or more of the flags in check_flags are set diff --git a/components/hal/include/hal/uart_hal.h b/components/hal/include/hal/uart_hal.h index ceec6a3469..7cc52405a0 100644 --- a/components/hal/include/hal/uart_hal.h +++ b/components/hal/include/hal/uart_hal.h @@ -15,7 +15,7 @@ /******************************************************************************* * NOTICE * The hal is not public api, don't use in application code. - * See readme.md in soc/include/hal/readme.md + * See readme.md in hal/include/hal/readme.md ******************************************************************************/ // The HAL layer for UART. diff --git a/components/hal/include/hal/wdt_hal.h b/components/hal/include/hal/wdt_hal.h index 0d0f650d5c..2347fb5978 100644 --- a/components/hal/include/hal/wdt_hal.h +++ b/components/hal/include/hal/wdt_hal.h @@ -15,7 +15,7 @@ /******************************************************************************* * NOTICE * The hal is not public api, don't use in application code. - * See readme.md in soc/include/hal/readme.md + * See readme.md in hal/include/hal/readme.md ******************************************************************************/ #pragma once diff --git a/components/soc/README.md b/components/soc/README.md index 461d391922..8f3d65f533 100644 --- a/components/soc/README.md +++ b/components/soc/README.md @@ -10,10 +10,10 @@ the component's subdirectories: #### `soc/include` #### `soc/include` contains header files which provide a hardware-agnostic interface to the SoC. The interface consists of -function declarations and abstracted types that other, higher level components can make use of in order to have code portable to +function declarations and abstracted types that other, higher level components can make use of in order to have code portable to all targets ESP-IDF supports. -The `hal` subdirectory contains an abstraction layer for interacting with/driving the hardware found in the SoC such as the peripherals +The `hal` subdirectory contains an abstraction layer for interacting with/driving the hardware found in the SoC such as the peripherals and 'core' hardware such as the CPU, MPU, caches, etc. It contains `xxx_hal.h` files for the function declarations and `xxx_types.h` for the abstracted types. The abstraction design is actually two levels -- oftentimes `xxx_hal.h` includes a lower-level header from a `xxx_ll.h`, which resides in the implementation, `soc/src` subdirectory. More on this abstraction design in the [`hal` subdirectory's README](include/hal/readme.md). diff --git a/components/soc/src/esp32s2/include/hal/dac_hal.h b/components/soc/src/esp32s2/include/hal/dac_hal.h index 370d4cb189..f7198246a7 100644 --- a/components/soc/src/esp32s2/include/hal/dac_hal.h +++ b/components/soc/src/esp32s2/include/hal/dac_hal.h @@ -15,7 +15,7 @@ /******************************************************************************* * NOTICE * The hal is not public api, don't use in application code. - * See readme.md in soc/include/hal/readme.md + * See readme.md in hal/include/hal/readme.md ******************************************************************************/ // The HAL layer for DAC (esp32s2 specific part) diff --git a/components/spi_flash/include/memspi_host_driver.h b/components/spi_flash/include/memspi_host_driver.h index a94260b26e..46336f67ce 100644 --- a/components/spi_flash/include/memspi_host_driver.h +++ b/components/spi_flash/include/memspi_host_driver.h @@ -56,7 +56,7 @@ esp_err_t memspi_host_init_pointers(memspi_host_inst_t *host, const memspi_host_ * NOTICE * Rest part of this file are part of the HAL layer * The HAL is not public api, don't use in application code. - * See readme.md in soc/include/hal/readme.md + * See readme.md in hal/include/hal/readme.md ******************************************************************************/ /**