Queue#
Functions#
Map virtual address to physical address.
Map physical address to virtual address.
Checks whether the semaphore is created and destroys the semaphore instance, if its created.
Initialize queue.
Enqueue packet into queue.
Dequeue packet from queue.
Return packet pending count in queue.
Block the queue.
Unblock the queue.
Initialize queue.
Enqueue packet into queue.
Dequeue packet from queue.
Return packet pending count in queue.
Block the queue.
Unblock the queue.
Enqueue packet from ISR into queue.
Function Documentation#
rsi_critical_section_entry#
rsi_reg_flags_t rsi_critical_section_entry (void )
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| void | N/A |
rsi_critical_section_exit#
void rsi_critical_section_exit (rsi_reg_flags_t xflags)
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| rsi_reg_flags_t | N/A | xflags |
rsi_virtual_to_physical_address#
void * rsi_virtual_to_physical_address (void * virtual_address)
Map virtual address to physical address.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| void * | [in] | virtual_address | - pointer to virtual address |
Returns
void
rsi_physical_to_virtual_address#
void * rsi_physical_to_virtual_address (void * physical_address)
Map physical address to virtual address.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| void * | [in] | physical_address | - pointer to physical_address |
Returns
void
rsi_mutex_create#
rsi_error_t rsi_mutex_create (rsi_mutex_handle_t * mutex)
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| rsi_mutex_handle_t * | N/A | mutex |
rsi_mutex_lock#
rsi_error_t rsi_mutex_lock (volatile rsi_mutex_handle_t * mutex)
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| volatile rsi_mutex_handle_t * | N/A | mutex |
rsi_mutex_unlock#
rsi_error_t rsi_mutex_unlock (volatile rsi_mutex_handle_t * mutex)
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| volatile rsi_mutex_handle_t * | N/A | mutex |
rsi_mutex_destroy#
rsi_error_t rsi_mutex_destroy (rsi_mutex_handle_t * mutex)
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| rsi_mutex_handle_t * | N/A | mutex |
rsi_semaphore_create#
rsi_error_t rsi_semaphore_create (rsi_semaphore_handle_t * semaphore, uint32_t count)
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| rsi_semaphore_handle_t * | N/A | semaphore | |
| uint32_t | N/A | count |
rsi_semaphore_destroy#
rsi_error_t rsi_semaphore_destroy (rsi_semaphore_handle_t * semaphore)
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| rsi_semaphore_handle_t * | N/A | semaphore |
rsi_semaphore_check_and_destroy#
rsi_error_t rsi_semaphore_check_and_destroy (rsi_semaphore_handle_t * semaphore)
Checks whether the semaphore is created and destroys the semaphore instance, if its created.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| rsi_semaphore_handle_t * | [in] | semaphore | - Semaphore handle pointer |
Returns
0 - Success
Negative Value - Failure
rsi_semaphore_wait#
rsi_error_t rsi_semaphore_wait (rsi_semaphore_handle_t * semaphore, uint32_t timeout_ms)
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| rsi_semaphore_handle_t * | N/A | semaphore | |
| uint32_t | N/A | timeout_ms |
rsi_semaphore_post_from_isr#
rsi_error_t rsi_semaphore_post_from_isr (rsi_semaphore_handle_t * semaphore)
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| rsi_semaphore_handle_t * | N/A | semaphore |
rsi_semaphore_post#
rsi_error_t rsi_semaphore_post (rsi_semaphore_handle_t * semaphore)
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| rsi_semaphore_handle_t * | N/A | semaphore |
rsi_semaphore_reset#
rsi_error_t rsi_semaphore_reset (rsi_semaphore_handle_t * semaphore)
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| rsi_semaphore_handle_t * | N/A | semaphore |
rsi_queues_init#
void rsi_queues_init (rsi_queue_cb_t * queue)
Initialize queue.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| rsi_queue_cb_t * | [in] | queue | - pointer to queue |
Returns
void
rsi_enqueue_pkt#
void rsi_enqueue_pkt (rsi_queue_cb_t * queue, rsi_pkt_t * pkt)
Enqueue packet into queue.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| rsi_queue_cb_t * | [in] | queue | - pointer to queue cb |
| rsi_pkt_t * | [in] | pkt | - packet pointer which needs to be queued |
Returns
void
rsi_dequeue_pkt#
rsi_pkt_t * rsi_dequeue_pkt (rsi_queue_cb_t * queue)
Dequeue packet from queue.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| rsi_queue_cb_t * | [in] | queue | - queue pointer from which packet needs to be dequeued |
Returns
Allocated pocket pointer - Success
NULL - Failure
rsi_check_queue_status#
uint32_t rsi_check_queue_status (rsi_queue_cb_t * queue)
Return packet pending count in queue.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| rsi_queue_cb_t * | [in] | queue | - pointer to queue |
Returns
0 - If queue masked
Number of packets pending - If queue is not masked
rsi_block_queue#
void rsi_block_queue (rsi_queue_cb_t * queue)
Block the queue.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| rsi_queue_cb_t * | [in] | queue | - pointer to queue |
Returns
void
rsi_unblock_queue#
void rsi_unblock_queue (rsi_queue_cb_t * queue)
Unblock the queue.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| rsi_queue_cb_t * | [in] | queue | - pointer to queue |
Returns
void
ROM_WL_rsi_queues_init#
void ROM_WL_rsi_queues_init (global_cb_t * global_cb_p, rsi_queue_cb_t * queue)
Initialize queue.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| global_cb_t * | [in] | global_cb_p | - pointer to queue |
| rsi_queue_cb_t * | [in] | queue | - pointer to the global control block |
Returns
void
ROM_WL_rsi_enqueue_pkt#
void ROM_WL_rsi_enqueue_pkt (global_cb_t * global_cb_p, rsi_queue_cb_t * queue, rsi_pkt_t * pkt)
Enqueue packet into queue.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| global_cb_t * | [in] | global_cb_p | - pointer to the global control block |
| rsi_queue_cb_t * | [in] | queue | - pointer to queue cb |
| rsi_pkt_t * | [in] | pkt | - packet pointer which needs to be queued |
Returns
void
ROM_WL_rsi_dequeue_pkt#
rsi_pkt_t * ROM_WL_rsi_dequeue_pkt (global_cb_t * global_cb_p, rsi_queue_cb_t * queue)
Dequeue packet from queue.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| global_cb_t * | [in] | global_cb_p | - pointer to the global control block |
| rsi_queue_cb_t * | [in] | queue | - queue pointer from which packet needs to be dequeued |
Returns
Allocated packet pointer - Success
NULL - Failure
ROM_WL_rsi_check_queue_status#
uint32_t ROM_WL_rsi_check_queue_status (global_cb_t * global_cb_p, rsi_queue_cb_t * queue)
Return packet pending count in queue.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| global_cb_t * | [in] | global_cb_p | - pointer to the global control block |
| rsi_queue_cb_t * | [in] | queue | - pointer to queue |
Returns
0 - If queue masked
Number of packets pending - If queue is not masked
ROM_WL_rsi_block_queue#
void ROM_WL_rsi_block_queue (global_cb_t * global_cb_p, rsi_queue_cb_t * queue)
Block the queue.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| global_cb_t * | [in] | global_cb_p | - pointer to the global control block |
| rsi_queue_cb_t * | [in] | queue | - pointer to queue |
Returns
void
ROM_WL_rsi_unblock_queue#
void ROM_WL_rsi_unblock_queue (global_cb_t * global_cb_p, rsi_queue_cb_t * queue)
Unblock the queue.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| global_cb_t * | [in] | global_cb_p | - pointer to the global control block |
| rsi_queue_cb_t * | [in] | queue | - pointer to queue |
Returns
void
ROM_WL_rsi_enqueue_pkt_from_isr#
void ROM_WL_rsi_enqueue_pkt_from_isr (global_cb_t * global_cb_p, rsi_queue_cb_t * queue, rsi_pkt_t * pkt)
Enqueue packet from ISR into queue.
| Type | Direction | Argument Name | Description |
|---|---|---|---|
| global_cb_t * | [in] | global_cb_p | - pointer to the global control block |
| rsi_queue_cb_t * | [in] | queue | - pointer to queue cb |
| rsi_pkt_t * | [in] | pkt | - packet pointer which needs to be queued |
Returns
void