Functions to handle the FIFO I/O. More...
Functions | |
| ptxStatus_t | ptxFifo_IoRq_Init (ptxFifoIoRq_t *fifoIoRq, struct ptxOsal *osAl, ptxLog_t *logger, size_t fifoCapacity) |
| Initialize the FIFO I/O Request Structure. | |
| ptxStatus_t | ptxFifo_IoRq_DeInit (ptxFifoIoRq_t *fifoIoRq) |
| Shut down the FIFO I/O Request Structure. | |
| ptxStatus_t | ptxFifo_IoRq_Post (ptxFifoIoRq_t *fifoIoRq, ptxIoRq_t *ioRq) |
| Post a new entry to the tail of FIFO that stores I/O requests. | |
| ptxStatus_t | ptxFifo_IoRq_PostQuitRequest (ptxFifoIoRq_t *fifoIoRq) |
| Post a thread exit request to the tail of FIFO. | |
Detailed Description
Functions to handle the FIFO I/O.
Function Documentation
◆ ptxFifo_IoRq_DeInit()
| ptxStatus_t ptxFifo_IoRq_DeInit | ( | ptxFifoIoRq_t * | fifoIoRq | ) |
Shut down the FIFO I/O Request Structure.
Shuts down the FIFO. Requires an already allocated FIFO object.
- Parameters
-
[in] fifoIoRq Pointer to the FIFO I/O Request structure.
- Returns
- Status of the operation. See definition of ptxStatus_t.
◆ ptxFifo_IoRq_Init()
| ptxStatus_t ptxFifo_IoRq_Init | ( | ptxFifoIoRq_t * | fifoIoRq, |
| struct ptxOsal * | osAl, | ||
| ptxLog_t * | logger, | ||
| size_t | fifoCapacity ) |
Initialize the FIFO I/O Request Structure.
FIFO I/O Request Structure Handling Functions
Initializes the FIFO. Requires an already-allocated FIFO object. Call this function before starting the use of the FIFO.
- Parameters
-
[in] fifoIoRq Pointer to the FIFO I/O Request structure. [in] osAl Pointer to the OSAL structure. [in] logger Pointer to the Logger component structure. [in] fifoCapacity Capacity of the FIFO.
- Returns
- Status of the operation. See definition of ptxStatus_t.
◆ ptxFifo_IoRq_Post()
| ptxStatus_t ptxFifo_IoRq_Post | ( | ptxFifoIoRq_t * | fifoIoRq, |
| ptxIoRq_t * | ioRq ) |
Post a new entry to the tail of FIFO that stores I/O requests.
The I/O Request FIFO will receive a new stack location by this function: The caller is responsible for allocating properly the I/O Rq object before call this function.
- Parameters
-
[in] fifoIoRq Pointer to the structure of the FIFO. [in] ioRq Pointer to the IO RQ that wants to be posted to the FIFO.
- Returns
- Status of the operation. See definition of ptxStatus_t.
◆ ptxFifo_IoRq_PostQuitRequest()
| ptxStatus_t ptxFifo_IoRq_PostQuitRequest | ( | ptxFifoIoRq_t * | fifoIoRq | ) |
Post a thread exit request to the tail of FIFO.
Once after taking the request from the FIFO, the handler thread will quit. The user must perform join on the thread before exiting the program.
- Parameters
-
[in] fifoIoRq Pointer to the structure of the FIFO.
- Returns
- Status of the operation. See definition of ptxStatus_t.
