drivers/crypto/intel/qat/qat_common/adf_admin.c
Source file repositories/reference/linux-study-clean/drivers/crypto/intel/qat/qat_common/adf_admin.c
File Facts
- System
- Linux kernel
- Corpus path
drivers/crypto/intel/qat/qat_common/adf_admin.c- Extension
.c- Size
- 23153 bytes
- Lines
- 720
- Domain
- Driver Families
- Bucket
- drivers/crypto
- Inferred role
- Driver Families: exported/initcall integration point
- Status
- integration implementation candidate
Why This File Exists
Repeatable hardware-adapter layer. Deep compatibility for every driver is out of scope; this atlas records patterns, probe lifecycles, bus glue, IRQ/DMA usage, and links back to core abstractions.
- Repeatable hardware-adapter layer. Deep compatibility for every driver is out of scope; this atlas records patterns, probe lifecycles, bus glue, IRQ/DMA usage, and links back to core abstractions.
- Exports symbols or registers init work; inspect boot/module ordering and who consumes the exported contract.
- Uses kernel synchronization; read lock ordering, sleepability, and interrupt context assumptions before translating.
- Touches IRQ or DMA behavior; this matters for the representative real-device path.
- Allocates kernel memory; connect allocation flags and lifetime to context constraints.
- Defines or uses C structs; map object ownership, embedded links, reference counts, and lock ownership.
Dependency Surface
linux/types.hlinux/mutex.hlinux/slab.hlinux/iopoll.hlinux/pci.hlinux/dma-mapping.hlinux/delay.hadf_accel_devices.hadf_admin.hadf_anti_rb.hadf_common_drv.hadf_cfg.hadf_heartbeat.hadf_kpt.hicp_qat_fw_init_admin.h
Detected Declarations
struct adf_admin_commsfunction adf_put_admin_msg_syncfunction adf_send_adminfunction adf_init_aefunction adf_set_fw_constantsfunction adf_get_fw_timestampfunction adf_set_chainingfunction adf_get_dc_capabilitiesfunction adf_get_ae_fw_countersfunction adf_send_admin_tim_syncfunction adf_send_admin_hb_timerfunction is_dcc_enabledfunction adf_get_fw_capabilitiesfunction adf_send_admin_rl_initfunction adf_send_admin_rl_add_updatefunction adf_send_admin_rl_deletefunction adf_send_admin_initfunction adf_init_admin_pmfunction adf_get_pm_infofunction adf_get_cnv_statsfunction adf_send_admin_tl_startfunction adf_send_admin_tl_stopfunction adf_send_admin_retryfunction adf_send_admin_svnfunction adf_send_admin_arb_queryfunction adf_send_admin_arb_commitfunction adf_cfg_kpt_configfunction adf_send_admin_kpt_initfunction adf_init_admin_commsfunction adf_exit_admin_commsexport adf_send_admin_initexport adf_init_admin_pmexport adf_init_admin_commsexport adf_exit_admin_comms
Annotated Snippet
struct adf_admin_comms {
dma_addr_t phy_addr;
dma_addr_t const_tbl_addr;
void *virt_addr;
void *virt_tbl_addr;
void __iomem *mailbox_addr;
struct mutex lock; /* protects adf_admin_comms struct */
};
static int adf_put_admin_msg_sync(struct adf_accel_dev *accel_dev, u32 ae,
void *in, void *out)
{
int ret;
u32 status;
struct adf_admin_comms *admin = accel_dev->admin;
int offset = ae * ADF_ADMINMSG_LEN * 2;
void __iomem *mailbox = admin->mailbox_addr;
int mb_offset = ae * ADF_ADMIN_MAILBOX_STRIDE;
struct icp_qat_fw_init_admin_req *request = in;
mutex_lock(&admin->lock);
if (ADF_CSR_RD(mailbox, mb_offset) == 1) {
mutex_unlock(&admin->lock);
return -EAGAIN;
}
memcpy(admin->virt_addr + offset, in, ADF_ADMINMSG_LEN);
ADF_CSR_WR(mailbox, mb_offset, 1);
ret = read_poll_timeout(ADF_CSR_RD, status, status == 0,
ADF_ADMIN_POLL_DELAY_US,
ADF_ADMIN_POLL_TIMEOUT_US, true,
mailbox, mb_offset);
if (ret < 0) {
/* Response timeout */
dev_err(&GET_DEV(accel_dev),
"Failed to send admin msg %d to accelerator %d\n",
request->cmd_id, ae);
} else {
/* Response received from admin message, we can now
* make response data available in "out" parameter.
*/
memcpy(out, admin->virt_addr + offset +
ADF_ADMINMSG_LEN, ADF_ADMINMSG_LEN);
}
mutex_unlock(&admin->lock);
return ret;
}
static int adf_send_admin(struct adf_accel_dev *accel_dev,
struct icp_qat_fw_init_admin_req *req,
struct icp_qat_fw_init_admin_resp *resp,
const unsigned long ae_mask)
{
u32 ae;
for_each_set_bit(ae, &ae_mask, ICP_QAT_HW_AE_DELIMITER)
if (adf_put_admin_msg_sync(accel_dev, ae, req, resp) ||
resp->status)
return -EFAULT;
return 0;
}
static int adf_init_ae(struct adf_accel_dev *accel_dev)
{
struct icp_qat_fw_init_admin_req req;
struct icp_qat_fw_init_admin_resp resp;
struct adf_hw_device_data *hw_device = accel_dev->hw_device;
u32 ae_mask = hw_device->ae_mask;
memset(&req, 0, sizeof(req));
memset(&resp, 0, sizeof(resp));
req.cmd_id = ICP_QAT_FW_INIT_AE;
return adf_send_admin(accel_dev, &req, &resp, ae_mask);
}
static int adf_set_fw_constants(struct adf_accel_dev *accel_dev)
{
struct icp_qat_fw_init_admin_req req;
struct icp_qat_fw_init_admin_resp resp;
struct adf_hw_device_data *hw_device = accel_dev->hw_device;
u32 ae_mask = hw_device->admin_ae_mask ?: hw_device->ae_mask;
memset(&req, 0, sizeof(req));
memset(&resp, 0, sizeof(resp));
req.cmd_id = ICP_QAT_FW_CONSTANTS_CFG;
Annotation
- Immediate include surface: `linux/types.h`, `linux/mutex.h`, `linux/slab.h`, `linux/iopoll.h`, `linux/pci.h`, `linux/dma-mapping.h`, `linux/delay.h`, `adf_accel_devices.h`.
- Detected declarations: `struct adf_admin_comms`, `function adf_put_admin_msg_sync`, `function adf_send_admin`, `function adf_init_ae`, `function adf_set_fw_constants`, `function adf_get_fw_timestamp`, `function adf_set_chaining`, `function adf_get_dc_capabilities`, `function adf_get_ae_fw_counters`, `function adf_send_admin_tim_sync`.
- Atlas domain: Driver Families / drivers/crypto.
- Implementation status: integration implementation candidate.
- Synchronization appears in or near this file; preserve lock ordering, sleepability, and interrupt-context constraints.
- IRQ or DMA behavior appears here, which is relevant to the selected PCIe/NVMe device path.
Implementation Notes
- This generated page is the file-by-file coverage layer; curated subsystem chapters should link here when they synthesize a multi-file control flow.
- Core OS pages should be promoted from atlas-only to deep-reviewed when they explain data structures, invariants, locking, lifecycle, and C implementation snippets.
- Driver-family pages are intentionally pattern-oriented unless they are part of the selected PCIe/NVMe representative device path.