From 6576ce930d7246ab8d089cf2968f998366d58659 Mon Sep 17 00:00:00 2001 From: Youssef Kandil Date: Sun, 12 Jan 2025 18:50:04 +0200 Subject: [PATCH] updating docs --- docs/doxygen/html/_e_f___s_p_i_8c.html | 46 + docs/doxygen/html/_e_f___s_p_i_8h_source.html | 4 +- docs/doxygen/html/_r_e_a_d_m_e_8md.html | 81 ++ docs/doxygen/html/globals.html | 2 +- docs/doxygen/html/globals_func.html | 2 +- docs/doxygen/html/md__r_e_a_d_m_e.html | 896 +++++++++++++ docs/doxygen/html/menudata.js | 1 + docs/doxygen/html/pages.html | 86 ++ docs/doxygen/html/search/all_1.js | 3 +- docs/doxygen/html/search/all_2.js | 79 +- docs/doxygen/html/search/all_3.js | 78 +- docs/doxygen/html/search/all_4.js | 4 +- docs/doxygen/html/search/all_5.js | 4 +- docs/doxygen/html/search/all_6.js | 2 +- docs/doxygen/html/search/all_7.js | 9 +- docs/doxygen/html/search/all_8.js | 10 +- docs/doxygen/html/search/all_9.js | 5 +- docs/doxygen/html/search/all_a.js | 7 + docs/doxygen/html/search/files_1.js | 4 + docs/doxygen/html/search/functions_0.js | 2 +- docs/doxygen/html/search/pages_0.js | 4 + docs/doxygen/html/search/searchdata.js | 13 +- docs/doxygen/latex/_e_f___s_p_i_8c.tex | 28 + docs/doxygen/latex/_r_e_a_d_m_e_8md.tex | 2 + docs/doxygen/latex/md__r_e_a_d_m_e.tex | 1079 +++++++++++++++ docs/doxygen/latex/refman.tex | 5 + docs/doxygen/xml/_e_f___s_p_i_8c.xml | 87 +- docs/doxygen/xml/_e_f___s_p_i_8h.xml | 4 +- docs/doxygen/xml/_r_e_a_d_m_e_8md.xml | 1013 +++++++++++++++ docs/doxygen/xml/index.xml | 5 + docs/doxygen/xml/md__r_e_a_d_m_e.xml | 1157 +++++++++++++++++ 31 files changed, 4599 insertions(+), 123 deletions(-) create mode 100644 docs/doxygen/html/_r_e_a_d_m_e_8md.html create mode 100644 docs/doxygen/html/md__r_e_a_d_m_e.html create mode 100644 docs/doxygen/html/pages.html create mode 100644 docs/doxygen/html/search/all_a.js create mode 100644 docs/doxygen/html/search/files_1.js create mode 100644 docs/doxygen/html/search/pages_0.js create mode 100644 docs/doxygen/latex/_r_e_a_d_m_e_8md.tex create mode 100644 docs/doxygen/latex/md__r_e_a_d_m_e.tex create mode 100644 docs/doxygen/xml/_r_e_a_d_m_e_8md.xml create mode 100644 docs/doxygen/xml/md__r_e_a_d_m_e.xml diff --git a/docs/doxygen/html/_e_f___s_p_i_8c.html b/docs/doxygen/html/_e_f___s_p_i_8c.html index 574e7cb..e55d36e 100644 --- a/docs/doxygen/html/_e_f___s_p_i_8c.html +++ b/docs/doxygen/html/_e_f___s_p_i_8c.html @@ -145,6 +145,8 @@   EF_DRIVER_STATUS EF_SPI_getMIS (EF_SPI_TYPE_PTR spi, uint32_t *mask)   +EF_DRIVER_STATUS EF_SPI_setICR (EF_SPI_TYPE_PTR spi, uint32_t mask) + 

Detailed Description

C file for SPI APIs which contains the function Implementations.

@@ -649,6 +651,50 @@

Returns
status A value of type EF_DRIVER_STATUS : returns a success or error code
+

+ + +

◆ EF_SPI_setICR()

+ +
+
+ + + + + + + + + + + + + + + + + + +
EF_DRIVER_STATUS EF_SPI_setICR (EF_SPI_TYPE_PTR spi,
uint32_t mask 
)
+
+

sets the value of the Interrupt Clear Register; which clears the interrupts The mask value is a 6-bit value, where each bit corresponds to a specific interrupt

    +
  • bit 0 TXE : Transmit FIFO is Empty.
    • +
  • bit 1 TXF : Transmit FIFO is Full.
    • +
  • bit 2 RXE : Receive FIFO is Empty.
    • +
  • bit 3 RXF : Receive FIFO is Full.
    • +
  • bit 4 TXB : Transmit FIFO level is Below Threshold.
    • +
  • bit 5 RXA : Receive FIFO level is Above Threshold.
    • +
+
Parameters
+ + + +
[in]spiAn EF_SPI_TYPE pointer, which points to the base memory address of SPI registers. EF_SPI_TYPE is a structure that contains the SPI registers.
[in]maskThe required mask value
+
+
+
Returns
status A value of type EF_DRIVER_STATUS : returns a success or error code
+
diff --git a/docs/doxygen/html/_e_f___s_p_i_8h_source.html b/docs/doxygen/html/_e_f___s_p_i_8h_source.html index 42b6de5..edcd53d 100644 --- a/docs/doxygen/html/_e_f___s_p_i_8h_source.html +++ b/docs/doxygen/html/_e_f___s_p_i_8h_source.html @@ -182,7 +182,7 @@
252
253
262
-
268EF_DRIVER_STATUS EF_SPI_setICR(EF_SPI_TYPE_PTR spi, uint32_t mask);
+
268EF_DRIVER_STATUS EF_SPI_setICR(EF_SPI_TYPE_PTR spi, uint32_t mask);
269
270
271/******************************************************************************
@@ -204,7 +204,7 @@
EF_SPI_getIM
EF_DRIVER_STATUS EF_SPI_getIM(EF_SPI_TYPE_PTR spi, uint32_t *mask)
Definition: EF_SPI.c:296
EF_SPI_readRxFifoEmpty
EF_DRIVER_STATUS EF_SPI_readRxFifoEmpty(EF_SPI_TYPE_PTR spi, uint32_t *RXfifo_state)
reads the RX FIFO empty flag from the STATUS register
Definition: EF_SPI.c:152
EF_SPI_enable
EF_DRIVER_STATUS EF_SPI_enable(EF_SPI_TYPE_PTR spi)
enables the SPI by setting the enable bit in the CTRL register to 1, enables spi master pulse generat...
Definition: EF_SPI.c:210
-
EF_SPI_setICR
EF_DRIVER_STATUS EF_SPI_setICR(EF_SPI_TYPE_PTR spi, uint32_t mask)
+
EF_SPI_setICR
EF_DRIVER_STATUS EF_SPI_setICR(EF_SPI_TYPE_PTR spi, uint32_t mask)
Definition: EF_SPI.c:343
EF_SPI_writeData
EF_DRIVER_STATUS EF_SPI_writeData(EF_SPI_TYPE_PTR spi, uint32_t data)
writes a byte of data to the TXDATA register
Definition: EF_SPI.c:73
EF_SPI_waitTxFifoEmpty
EF_DRIVER_STATUS EF_SPI_waitTxFifoEmpty(EF_SPI_TYPE_PTR spi)
waits for the TX FIFO to be empty by polling the TX FIFO empty flag in the STATUS register
Definition: EF_SPI.c:168
EF_SPI_disableRx
EF_DRIVER_STATUS EF_SPI_disableRx(EF_SPI_TYPE_PTR spi)
disables the RX by setting the RX enable bit in the CTRL register to 0, disables storing bytes reciev...
Definition: EF_SPI.c:246
diff --git a/docs/doxygen/html/_r_e_a_d_m_e_8md.html b/docs/doxygen/html/_r_e_a_d_m_e_8md.html new file mode 100644 index 0000000..e8ec3d3 --- /dev/null +++ b/docs/doxygen/html/_r_e_a_d_m_e_8md.html @@ -0,0 +1,81 @@ + + + + + + + +EF_SPI APIs: README.md File Reference + + + + + + + + + +
+
+ + + + + + +
+
EF_SPI APIs +
+
+
+ + + + + + + + +
+
+ + +
+
+
+
+
+
Loading...
+
Searching...
+
No Matches
+
+
+
+
+ +
+
+
README.md File Reference
+
+
+
+ +
+Generated by doxygen 1.9.6 +
+ + diff --git a/docs/doxygen/html/globals.html b/docs/doxygen/html/globals.html index 47740a6..0eb2ab6 100644 --- a/docs/doxygen/html/globals.html +++ b/docs/doxygen/html/globals.html @@ -121,7 +121,7 @@

- e -