ソースを参照

hal: update link to HAL readme.md

The HAL readme was moved during refactoring, but links were not updated.
Marius Vikhammer 5 年 前
コミット
b2f390df01
68 ファイル変更105 行追加105 行削除
  1. 1 1
      components/hal/esp32/include/hal/adc_hal.h
  2. 2 2
      components/hal/esp32/include/hal/can_hal.h
  3. 1 1
      components/hal/esp32/include/hal/can_ll.h
  4. 1 1
      components/hal/esp32/include/hal/dac_ll.h
  5. 1 1
      components/hal/esp32/include/hal/gpio_ll.h
  6. 1 1
      components/hal/esp32/include/hal/i2s_ll.h
  7. 1 1
      components/hal/esp32/include/hal/mcpwm_ll.h
  8. 1 1
      components/hal/esp32/include/hal/pcnt_ll.h
  9. 1 1
      components/hal/esp32/include/hal/rtc_io_ll.h
  10. 1 1
      components/hal/esp32/include/hal/sigmadelta_ll.h
  11. 1 1
      components/hal/esp32/include/hal/spi_flash_ll.h
  12. 1 1
      components/hal/esp32/include/hal/spi_ll.h
  13. 1 1
      components/hal/esp32/include/hal/touch_sensor_hal.h
  14. 1 1
      components/hal/esp32/include/hal/touch_sensor_ll.h
  15. 7 7
      components/hal/esp32/include/hal/twai_ll.h
  16. 1 1
      components/hal/esp32s2/include/hal/adc_hal.h
  17. 2 2
      components/hal/esp32s2/include/hal/dac_ll.h
  18. 1 1
      components/hal/esp32s2/include/hal/gpio_ll.h
  19. 1 1
      components/hal/esp32s2/include/hal/gpspi_flash_ll.h
  20. 1 1
      components/hal/esp32s2/include/hal/i2s_ll.h
  21. 1 1
      components/hal/esp32s2/include/hal/pcnt_ll.h
  22. 1 1
      components/hal/esp32s2/include/hal/rtc_io_ll.h
  23. 1 1
      components/hal/esp32s2/include/hal/sigmadelta_ll.h
  24. 1 1
      components/hal/esp32s2/include/hal/spi_flash_ll.h
  25. 1 1
      components/hal/esp32s2/include/hal/spi_ll.h
  26. 1 1
      components/hal/esp32s2/include/hal/spimem_flash_ll.h
  27. 1 1
      components/hal/esp32s2/include/hal/touch_sensor_hal.h
  28. 1 1
      components/hal/esp32s2/include/hal/touch_sensor_ll.h
  29. 7 7
      components/hal/esp32s2/include/hal/twai_ll.h
  30. 1 1
      components/hal/esp32s3/include/hal/adc_hal.h
  31. 1 1
      components/hal/esp32s3/include/hal/dac_ll.h
  32. 1 1
      components/hal/esp32s3/include/hal/gpio_ll.h
  33. 1 1
      components/hal/esp32s3/include/hal/gpspi_flash_ll.h
  34. 1 1
      components/hal/esp32s3/include/hal/i2s_ll.h
  35. 1 1
      components/hal/esp32s3/include/hal/mcpwm_ll.h
  36. 1 1
      components/hal/esp32s3/include/hal/pcnt_ll.h
  37. 1 1
      components/hal/esp32s3/include/hal/rtc_io_ll.h
  38. 1 1
      components/hal/esp32s3/include/hal/sigmadelta_ll.h
  39. 1 1
      components/hal/esp32s3/include/hal/spi_flash_ll.h
  40. 1 1
      components/hal/esp32s3/include/hal/spi_ll.h
  41. 1 1
      components/hal/esp32s3/include/hal/spimem_flash_ll.h
  42. 1 1
      components/hal/esp32s3/include/hal/touch_sensor_hal.h
  43. 1 1
      components/hal/esp32s3/include/hal/touch_sensor_ll.h
  44. 6 6
      components/hal/esp32s3/include/hal/twai_ll.h
  45. 1 1
      components/hal/include/hal/brownout_hal.h
  46. 1 1
      components/hal/include/hal/dac_hal.h
  47. 7 7
      components/hal/include/hal/gpio_hal.h
  48. 10 10
      components/hal/include/hal/i2c_hal.h
  49. 1 1
      components/hal/include/hal/i2s_hal.h
  50. 1 1
      components/hal/include/hal/ledc_hal.h
  51. 1 1
      components/hal/include/hal/mcpwm_hal.h
  52. 1 1
      components/hal/include/hal/pcnt_hal.h
  53. 1 1
      components/hal/include/hal/rtc_io_hal.h
  54. 1 1
      components/hal/include/hal/sdio_slave_hal.h
  55. 1 1
      components/hal/include/hal/sdio_slave_ll.h
  56. 1 1
      components/hal/include/hal/sigmadelta_hal.h
  57. 1 1
      components/hal/include/hal/spi_flash_hal.h
  58. 1 1
      components/hal/include/hal/spi_hal.h
  59. 1 1
      components/hal/include/hal/spi_slave_hal.h
  60. 1 1
      components/hal/include/hal/spi_slave_hd_hal.h
  61. 1 1
      components/hal/include/hal/timer_hal.h
  62. 1 1
      components/hal/include/hal/touch_sensor_hal.h
  63. 3 3
      components/hal/include/hal/twai_hal.h
  64. 1 1
      components/hal/include/hal/uart_hal.h
  65. 1 1
      components/hal/include/hal/wdt_hal.h
  66. 2 2
      components/soc/README.md
  67. 1 1
      components/soc/src/esp32s2/include/hal/dac_hal.h
  68. 1 1
      components/spi_flash/include/memspi_host_driver.h

+ 1 - 1
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)

+ 2 - 2
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)

+ 1 - 1
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

+ 1 - 1
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

+ 1 - 1
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

+ 1 - 1
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

+ 1 - 1
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

+ 1 - 1
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

+ 1 - 1
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

+ 1 - 1
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

+ 1 - 1
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

+ 1 - 1
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

+ 1 - 1
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)

+ 1 - 1
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

+ 7 - 7
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

+ 1 - 1
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)

+ 2 - 2
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)

+ 1 - 1
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

+ 1 - 1
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

+ 1 - 1
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

+ 1 - 1
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

+ 1 - 1
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

+ 1 - 1
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

+ 1 - 1
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

+ 1 - 1
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

+ 1 - 1
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

+ 1 - 1
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)

+ 1 - 1
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

+ 7 - 7
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
  */

+ 1 - 1
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)

+ 1 - 1
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

+ 1 - 1
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

+ 1 - 1
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

+ 1 - 1
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

+ 1 - 1
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

+ 1 - 1
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

+ 1 - 1
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

+ 1 - 1
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

+ 1 - 1
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

+ 1 - 1
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

+ 1 - 1
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

+ 1 - 1
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)

+ 1 - 1
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

+ 6 - 6
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

+ 1 - 1
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

+ 1 - 1
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

+ 7 - 7
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)

+ 10 - 10
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

+ 1 - 1
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.

+ 1 - 1
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.

+ 1 - 1
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)

+ 1 - 1
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.

+ 1 - 1
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)

+ 1 - 1
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)

+ 1 - 1
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

+ 1 - 1
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.

+ 1 - 1
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)

+ 1 - 1
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)

+ 1 - 1
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)

+ 1 - 1
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
  ******************************************************************************/
 
 /*

+ 1 - 1
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.

+ 1 - 1
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)

+ 3 - 3
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

+ 1 - 1
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.

+ 1 - 1
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

+ 2 - 2
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).

+ 1 - 1
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)

+ 1 - 1
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
  ******************************************************************************/
 
 /**