mirror
/
esp-idf
kopia lustrzana https://github.com/espressif/esp-idf
1
0
Forkuj 0
Kod Zgłoszenia Projekty Wydania Wiki Aktywność

Merge branch 'docs/fix_typo_in_head_file' into 'master' 

docs: fix typo in sdmmc_cmd.h and inconsistency in spi_master.h

Closes DOC-2397 and DOC-2382

See merge request espressif/esp-idf!16368
pull/8089/head
Mo Fei Fei 2021-12-14 02:44:03 +00:00
rodzic 1d0ae38c11 467525f846
commit 7929f6eb65
2 zmienionych plików z 5 dodań i 5 usunięć
Pokaż statystyki Ściągnij plik aktualizacji Ściągnij plik porównania Expand all files Collapse all files

4
components/driver/include/driver/spi_master.h
Wyświetl plik

@ -197,7 +197,7 @@ esp_err_t spi_bus_remove_device(spi_device_handle_t handle);
* @param ticks_to_wait Ticks to wait until there's room in the queue; use portMAX_DELAY to * @param ticks_to_wait Ticks to wait until there's room in the queue; use portMAX_DELAY to
* never time out. * never time out.
* @return * @return
* - ESP_ERR_INVALID_ARG if parameter is invalid. This can happen if SPI_DEVICE_CS_KEEP_LOW flag is specified while * - ESP_ERR_INVALID_ARG if parameter is invalid. This can happen if SPI_TRANS_CS_KEEP_ACTIVE flag is specified while
* the bus was not acquired (`spi_device_acquire_bus()` should be called first) * the bus was not acquired (`spi_device_acquire_bus()` should be called first)
* - ESP_ERR_TIMEOUT if there was no room in the queue before ticks_to_wait expired * - ESP_ERR_TIMEOUT if there was no room in the queue before ticks_to_wait expired
* - ESP_ERR_NO_MEM if allocating DMA-capable temporary buffer failed * - ESP_ERR_NO_MEM if allocating DMA-capable temporary buffer failed
@ -261,7 +261,7 @@ esp_err_t spi_device_transmit(spi_device_handle_t handle, spi_transaction_t *tra
* currently only portMAX_DELAY is supported. * currently only portMAX_DELAY is supported.
* *
* @return * @return
* - ESP_ERR_INVALID_ARG if parameter is invalid. This can happen if SPI_DEVICE_CS_KEEP_LOW flag is specified while * - ESP_ERR_INVALID_ARG if parameter is invalid. This can happen if SPI_TRANS_CS_KEEP_ACTIVE flag is specified while
* the bus was not acquired (`spi_device_acquire_bus()` should be called first) * the bus was not acquired (`spi_device_acquire_bus()` should be called first)
* - ESP_ERR_TIMEOUT if the device cannot get control of the bus before ``ticks_to_wait`` expired * - ESP_ERR_TIMEOUT if the device cannot get control of the bus before ``ticks_to_wait`` expired
* - ESP_ERR_NO_MEM if allocating DMA-capable temporary buffer failed * - ESP_ERR_NO_MEM if allocating DMA-capable temporary buffer failed

6
components/sdmmc/include/sdmmc_cmd.h
Wyświetl plik

@ -224,10 +224,10 @@ esp_err_t sdmmc_io_enable_int(sdmmc_card_t* card);
esp_err_t sdmmc_io_wait_int(sdmmc_card_t* card, TickType_t timeout_ticks); esp_err_t sdmmc_io_wait_int(sdmmc_card_t* card, TickType_t timeout_ticks);
/** /**
* Get the data of CIS region of a SDIO card. * Get the data of CIS region of an SDIO card.
* *
* You may provide a buffer not sufficient to store all the CIS data. In this * You may provide a buffer not sufficient to store all the CIS data. In this
* case, this functions store as much data into your buffer as possible. Also, * case, this function stores as much data into your buffer as possible. Also,
* this function will try to get and return the size required for you. * this function will try to get and return the size required for you.
* *
* @param card pointer to card information structure previously initialized * @param card pointer to card information structure previously initialized
@ -253,7 +253,7 @@ esp_err_t sdmmc_io_wait_int(sdmmc_card_t* card, TickType_t timeout_ticks);
esp_err_t sdmmc_io_get_cis_data(sdmmc_card_t* card, uint8_t* out_buffer, size_t buffer_size, size_t* inout_cis_size); esp_err_t sdmmc_io_get_cis_data(sdmmc_card_t* card, uint8_t* out_buffer, size_t buffer_size, size_t* inout_cis_size);
/** /**
* Parse and print the CIS information of a SDIO card. * Parse and print the CIS information of an SDIO card.
* *
* @note Not all the CIS codes and all kinds of tuples are supported. If you * @note Not all the CIS codes and all kinds of tuples are supported. If you
* see some unresolved code, you can add the parsing of these code in * see some unresolved code, you can add the parsing of these code in