# /space/home/slher/rel/Beken/v6_4_5/macsw/plf/refip/src/driver/ipc/ipc_emb.h File Reference

IPC module context on emb side. More...

`#include "co_int.h"`
`#include "co_bool.h"`
`#include "compiler.h"`
`#include "co_status.h"`
`#include "ipc_shared.h"`
`#include "ke_queue.h"`
`#include "ke_event.h"`
`#include "reg_ipc_emb.h"`

Go to the source code of this file.

## Data Structures
struct | ipc_emb_env_tag
| Structure describing the IPC environment. More...
## Functions
__INLINE uint32_t | ipc_emb_tx_pattern_addr_get (void)
| Get the host address of the TX payload descriptor pattern.
__INLINE uint32_t | ipc_emb_buffered_get (uint8_t sta, uint8_t tid)
| Get the buffered data from the IPC shared memory for a given sta/tid.
__INLINE bool | ipc_emb_tx_q_has_data (int queue_idx)
| Check if some TX descriptors are available on the requested queue.
uint8_t | ipc_emb_tx_q_len (int queue_idx, int vif_idx)
| Check how many tx descriptors are available on the requested queue for a VIF.
__INLINE uint32_t | ipc_emb_tx_evt_field (uint32_t stat)
| Convert a TX descriptor interrupt status in to the corresponding kernel event bit field.
__INLINE void | ipc_emb_enable_users (int queue_idx, uint8_t active_users)
| Re-enable the user queues that were disabled.
void | ipc_emb_radar_event_ind (void)
| Indicate to the upper side that at least one radar event is pending.
void | ipc_emb_txcfm_ind (uint32_t queue_bits)
| Indicate to the upper side that at least on confirmation is pending.
void | ipc_emb_prim_tbtt_ind (void)
| Indicate to the upper side that the primary TBTT is pending.
void | ipc_emb_sec_tbtt_ind (void)
| Indicate to the upper side that the secondary TBTT is pending.
bool | ipc_emb_hostrxbuf_check (void)
| Checks if a host buffer is currently available.
uint32_t | ipc_emb_hostrxbuf_get (uint32_t *host_id)
| Retrieve a hostbuf address for future DMA transfer.
bool | ipc_emb_hostrxdesc_check (void)
| Check if a RX descriptor is available.
uint32_t | ipc_emb_hostrxdesc_get (void)
| Retrieve a host RX descriptor address for future DMA transfer.
uint32_t | ipc_emb_hostdbgdumpbuf_get (void)
| Retrieve a hostbuf address for debug dump transfer.
uint32_t | ipc_emb_hostradarbuf_get (void)
| Retrieve a hostbuf address for future radar event DMA transfer.
void | ipc_emb_rxdata_ind (void)
| Sends an Data Reception Indication to the upper layer.
void | ipc_emb_kmsg_fwd (const struct ke_msg *ke_msg)
| Forward a kernel message to the host side (emb side).
void | ipc_emb_init (void)
| Initialize the IPC on the embedded side.
void | ipc_emb_tx_flow_off (void)
| Stop the TX flow between the upper layers and the LMAC software.
void | ipc_emb_tx_flow_on (void)
| Restart the TX flow between the upper layers and the LMAC software.
void | ipc_emb_tx_irq (void)
| Handle Tx packet interrupt on the emb side.
void | ipc_emb_msg_irq (void)
| IRQ handler.
void | ipc_emb_cfmback_irq (void)
| IRQ handler.
void | ipc_emb_tx_evt (int queue_idx)
| Kernel event handler for the handling of the TX descriptor pushed by the host.
void | ipc_emb_msg_evt (int dummy)
| EVT handler.
void | ipc_emb_msg_dma_int_handler (void)
| Handles the DMA interrupt generated when the MSG from Embedded side to Application has been transferred.
void | ipc_emb_print_fwd (bool poll, const uint32_t len, char *string)
| Send an EMB string to the APP - IPC API function.
void | ipc_emb_dbg_dma_int_handler (void)
| Handles the DMA interrupt generated when the Debug message from Embedded side to Application has been transferred.
## Variables
struct ipc_emb_env_tag | ipc_emb_env
| Embedded IPC environment variable.
const int | nx_txdesc_cnt_msk []
| Mask of the TX descriptor length per queue.

## Detailed Description

IPC module context on emb side.

Copyright (C) RivieraWaves 2011-2019

Definition in file ipc_emb.h.