drivers/ufs/core/ufshcd-priv.h

File Facts

System

Linux kernel

Corpus path

drivers/ufs/core/ufshcd-priv.h

Extension

.h

Size

14842 bytes

Lines

510

Domain

Driver Families

Bucket

drivers/ufs

Inferred role

Driver Families: implementation source

Status

source 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.
• Defines or uses C structs; map object ownership, embedded links, reference counts, and lock ownership.

Dependency Surface

• linux/pm_runtime.h
• ufs/ufshcd.h

Detected Declarations

• enum ufs_descr_fmt
• function ufshcd_is_user_access_allowed
• function ufshcd_keep_autobkops_enabled_except_suspend
• function ufshcd_wb_get_query_index
• function ufshcd_is_wb_buf_flush_allowed
• function ufs_hwmon_probe
• function ufshcd_vops_exit
• function ufshcd_vops_get_ufs_hci_version
• function ufshcd_vops_clk_scale_notify
• function ufshcd_vops_event_notify
• function ufshcd_vops_setup_clocks
• function ufshcd_vops_hce_enable_notify
• function ufshcd_vops_link_startup_notify
• function ufshcd_vops_negotiate_pwr_mode
• function ufshcd_vops_pwr_change_notify
• function ufshcd_vops_setup_task_mgmt
• function ufshcd_vops_hibern8_notify
• function ufshcd_vops_apply_dev_quirks
• function ufshcd_vops_fixup_dev_quirks
• function ufshcd_vops_suspend
• function ufshcd_vops_resume
• function ufshcd_vops_dbg_register_dump
• function ufshcd_vops_device_reset
• function ufshcd_vops_config_scaling_param
• function ufshcd_vops_mcq_config_resource
• function ufshcd_mcq_vops_op_runtime_config
• function ufshcd_vops_get_outstanding_cqs
• function ufshcd_mcq_vops_config_esi
• function ufshcd_vops_freq_to_gear_speed
• function ufshcd_vops_get_rx_fom
• function ufshcd_vops_apply_tx_eqtr_settings
• function ufshcd_vops_tx_eqtr_notify
• function ufshcd_scsi_to_upiu_lun
• function ufshcd_update_ee_drv_mask
• function ufshcd_update_ee_usr_mask
• function ufshcd_rpm_get_sync
• function ufshcd_rpm_get_if_active
• function ufshcd_rpm_put_sync
• function ufshcd_rpm_get_noresume
• function ufshcd_rpm_resume
• function ufshcd_rpm_put
• function ufs_is_valid_unit_desc_lun
• function ufshcd_inc_sq_tail
• function ufshcd_mcq_update_cq_tail_slot
• function ufshcd_mcq_is_cq_empty
• function ufshcd_mcq_inc_cq_head_slot
• function ufshcd_mcq_update_cq_head
• function ufshcd_mcq_get_sq_head_slot

Annotated Snippet

static inline void ufs_hwmon_probe(struct ufs_hba *hba, u8 mask) {}
static inline void ufs_hwmon_remove(struct ufs_hba *hba) {}
static inline void ufs_hwmon_notify_event(struct ufs_hba *hba, u8 ee_mask) {}
#endif

int ufshcd_query_descriptor_retry(struct ufs_hba *hba,
				  enum query_opcode opcode,
				  enum desc_idn idn, u8 index,
				  u8 selector,
				  u8 *desc_buf, int *buf_len);
int ufshcd_read_desc_param(struct ufs_hba *hba,
			   enum desc_idn desc_id,
			   int desc_index,
			   u8 param_offset,
			   u8 *param_read_buf,
			   u8 param_size);
int ufshcd_query_attr_retry(struct ufs_hba *hba, enum query_opcode opcode,
			    enum attr_idn idn, u8 index, u8 selector,
			    u32 *attr_val);
int ufshcd_query_attr(struct ufs_hba *hba, enum query_opcode opcode,
		      enum attr_idn idn, u8 index, u8 selector, u32 *attr_val);
int ufshcd_query_attr_qword(struct ufs_hba *hba, enum query_opcode opcode,
			    enum attr_idn idn, u8 index, u8 sel, u64 *attr_val);
int ufshcd_query_flag(struct ufs_hba *hba, enum query_opcode opcode,
	enum flag_idn idn, u8 index, bool *flag_res);
void ufshcd_auto_hibern8_update(struct ufs_hba *hba, u32 ahit);
void ufshcd_compl_one_cqe(struct ufs_hba *hba, int task_tag,
			  struct cq_entry *cqe);
int ufshcd_mcq_init(struct ufs_hba *hba);
void ufshcd_mcq_disable(struct ufs_hba *hba);
int ufshcd_get_hba_mac(struct ufs_hba *hba);
int ufshcd_mcq_memory_alloc(struct ufs_hba *hba);
struct ufs_hw_queue *ufshcd_mcq_req_to_hwq(struct ufs_hba *hba,
					   struct request *req);
void ufshcd_mcq_compl_all_cqes_lock(struct ufs_hba *hba,
				    struct ufs_hw_queue *hwq);
bool ufshcd_cmd_inflight(struct scsi_cmnd *cmd);
int ufshcd_mcq_sq_cleanup(struct ufs_hba *hba, int task_tag);
int ufshcd_mcq_abort(struct scsi_cmnd *cmd);
u32 ufshcd_mcq_read_mcqiacr(struct ufs_hba *hba, int i);
void ufshcd_mcq_write_mcqiacr(struct ufs_hba *hba, u32 val, int i);
int ufshcd_try_to_abort_task(struct ufs_hba *hba, int tag);
void ufshcd_release_scsi_cmd(struct ufs_hba *hba, struct scsi_cmnd *cmd);
int ufshcd_pause_command_processing(struct ufs_hba *hba, u64 timeout_us);
void ufshcd_resume_command_processing(struct ufs_hba *hba);
int ufshcd_scale_clks(struct ufs_hba *hba, unsigned long freq, bool scale_up);

/**
 * enum ufs_descr_fmt - UFS string descriptor format
 * @SD_RAW: Raw UTF-16 format
 * @SD_ASCII_STD: Convert to null-terminated ASCII string
 */
enum ufs_descr_fmt {
	SD_RAW = 0,
	SD_ASCII_STD = 1,
};

int ufshcd_read_string_desc(struct ufs_hba *hba, u8 desc_index, u8 **buf, enum ufs_descr_fmt fmt);
int ufshcd_send_uic_cmd(struct ufs_hba *hba, struct uic_command *uic_cmd);
int ufshcd_send_bsg_uic_cmd(struct ufs_hba *hba, struct uic_command *uic_cmd);

int ufshcd_exec_raw_upiu_cmd(struct ufs_hba *hba,
			     struct utp_upiu_req *req_upiu,
			     struct utp_upiu_req *rsp_upiu,
			     enum upiu_request_transaction msgcode,
			     u8 *desc_buff, int *buff_len,
			     enum query_opcode desc_op);

int ufshcd_wb_toggle(struct ufs_hba *hba, bool enable);

int ufshcd_uic_tx_eqtr(struct ufs_hba *hba, int gear);
void ufshcd_apply_valid_tx_eq_settings(struct ufs_hba *hba);
int ufshcd_config_tx_eq_settings(struct ufs_hba *hba,
				 struct ufs_pa_layer_attr *pwr_mode,
				 bool force_tx_eqtr);
void ufshcd_print_tx_eq_params(struct ufs_hba *hba);
bool ufshcd_is_txeq_presets_used(struct ufs_hba *hba);
bool ufshcd_is_txeq_preset_selected(u8 preshoot, u8 deemphasis);
int ufshcd_retrain_tx_eq(struct ufs_hba *hba, u32 gear);
void ufshcd_retrieve_tx_eq_settings(struct ufs_hba *hba);
void ufshcd_store_tx_eq_settings(struct ufs_hba *hba);

/* Wrapper functions for safely calling variant operations */
static inline const char *ufshcd_get_var_name(struct ufs_hba *hba)
{
	if (hba->vops)
		return hba->vops->name;
	return "";
}

Annotation

• Immediate include surface: `linux/pm_runtime.h`, `ufs/ufshcd.h`.
• Detected declarations: `enum ufs_descr_fmt`, `function ufshcd_is_user_access_allowed`, `function ufshcd_keep_autobkops_enabled_except_suspend`, `function ufshcd_wb_get_query_index`, `function ufshcd_is_wb_buf_flush_allowed`, `function ufs_hwmon_probe`, `function ufshcd_vops_exit`, `function ufshcd_vops_get_ufs_hci_version`, `function ufshcd_vops_clk_scale_notify`, `function ufshcd_vops_event_notify`.
• Atlas domain: Driver Families / drivers/ufs.
• Implementation status: source implementation candidate.

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.