DOCA uar
Collaboration diagram for DOCA uar:
Enumerations | |
| enum | doca_uar_allocation_type { DOCA_UAR_ALLOCATION_TYPE_BLUEFLAME = 0 , DOCA_UAR_ALLOCATION_TYPE_NONCACHE = 1 , DOCA_UAR_ALLOCATION_TYPE_NONCACHE_DEDICATED = 2 } |
| UAR allocation type. More... | |
Functions | |
| DOCA_EXPERIMENTAL doca_error_t | doca_uar_create (const struct doca_dev *dev, enum doca_uar_allocation_type allocation_type, struct doca_uar **uar) |
| Creates a UAR object. More... | |
| DOCA_EXPERIMENTAL doca_error_t | doca_uar_dpa_create (struct doca_dpa *dpa, struct doca_uar **uar) |
| Creates a DPA UAR object. More... | |
| DOCA_EXPERIMENTAL doca_error_t | doca_uar_destroy (struct doca_uar *uar) |
| Destroy UAR object. More... | |
| DOCA_EXPERIMENTAL doca_error_t | doca_uar_id_get (const struct doca_uar *uar, uint32_t *id) |
| Returns the uar id. More... | |
| DOCA_EXPERIMENTAL doca_error_t | doca_uar_page_get (const struct doca_uar *uar, void **page) |
| Returns the uar page address. More... | |
| DOCA_EXPERIMENTAL doca_error_t | doca_uar_reg_addr_get (const struct doca_uar *uar, void **reg) |
| Returns the uar register address. More... | |
Detailed Description
The DOCA UAR represents a user mapped memory
Enumeration Type Documentation
◆ doca_uar_allocation_type
UAR allocation type.
| Enumerator | |
|---|---|
| DOCA_UAR_ALLOCATION_TYPE_BLUEFLAME | |
| DOCA_UAR_ALLOCATION_TYPE_NONCACHE | |
| DOCA_UAR_ALLOCATION_TYPE_NONCACHE_DEDICATED | |
Definition at line 52 of file doca_uar.h.
Function Documentation
◆ doca_uar_create()
| DOCA_EXPERIMENTAL doca_error_t doca_uar_create | ( | const struct doca_dev * | dev, |
| enum doca_uar_allocation_type | allocation_type, | ||
| struct doca_uar ** | uar | ||
| ) |
Creates a UAR object.
- Parameters
-
[in] dev doca device [in] allocation_type doca_uar_allocation_type [out] uar uar object
- Returns
- DOCA_SUCCESS - in case of success. doca_error code - in case of failure:
- DOCA_ERROR_INVALID_VALUE - received invalid input.
- DOCA_ERROR_DRIVER - in case of error in a DOCA driver call.
◆ doca_uar_destroy()
| DOCA_EXPERIMENTAL doca_error_t doca_uar_destroy | ( | struct doca_uar * | uar | ) |
Destroy UAR object.
- Parameters
-
[in] uar uar object
- Returns
- DOCA_SUCCESS - in case of success. doca_error code - in case of failure:
- DOCA_ERROR_INVALID_VALUE - received invalid input.
◆ doca_uar_dpa_create()
| DOCA_EXPERIMENTAL doca_error_t doca_uar_dpa_create | ( | struct doca_dpa * | dpa, |
| struct doca_uar ** | uar | ||
| ) |
Creates a DPA UAR object.
- Parameters
-
[in] dpa doca dpa ctx to create UAR for [out] uar uar object
- Returns
- DOCA_SUCCESS - in case of success. doca_error code - in case of failure:
- DOCA_ERROR_INVALID_VALUE - received invalid input.
- DOCA_ERROR_DRIVER - in case of error in a DOCA driver call.
◆ doca_uar_id_get()
| DOCA_EXPERIMENTAL doca_error_t doca_uar_id_get | ( | const struct doca_uar * | uar, |
| uint32_t * | id | ||
| ) |
Returns the uar id.
- Parameters
-
[in] uar uar object [out] id uar object id
- Returns
- DOCA_SUCCESS - in case of success. doca_error code - in case of failure:
- DOCA_ERROR_INVALID_VALUE - received invalid input.
◆ doca_uar_page_get()
| DOCA_EXPERIMENTAL doca_error_t doca_uar_page_get | ( | const struct doca_uar * | uar, |
| void ** | page | ||
| ) |
Returns the uar page address.
- Note
- Not supported for DPA UAR
- Parameters
-
[in] uar uar object [out] page uar page address
- Returns
- DOCA_SUCCESS - in case of success. doca_error code - in case of failure:
- DOCA_ERROR_INVALID_VALUE - received invalid input.
◆ doca_uar_reg_addr_get()
| DOCA_EXPERIMENTAL doca_error_t doca_uar_reg_addr_get | ( | const struct doca_uar * | uar, |
| void ** | reg | ||
| ) |
Returns the uar register address.
- Note
- Not supported for DPA UAR
- Parameters
-
[in] uar uar object [out] reg uar register address
- Returns
- DOCA_SUCCESS - in case of success. doca_error code - in case of failure:
- DOCA_ERROR_INVALID_VALUE - received invalid input.
