/* SPDX-License-Identifier: GPL-2.0-or-later */ /* * iSCSI transport class definitions * * Copyright (C) IBM Corporation, 2004 * Copyright (C) Mike Christie, 2004 - 2006 * Copyright (C) Dmitry Yusupov, 2004 - 2005 * Copyright (C) Alex Aizman, 2004 - 2005 */ #ifndef SCSI_TRANSPORT_ISCSI_H #define SCSI_TRANSPORT_ISCSI_H #include <linux/device.h> #include <linux/list.h> #include <linux/mutex.h> #include <scsi/iscsi_if.h> struct scsi_transport_template; struct iscsi_transport; struct iscsi_endpoint; struct Scsi_Host; struct scsi_cmnd; struct iscsi_cls_conn; struct iscsi_conn; struct iscsi_task; struct sockaddr; struct iscsi_iface; struct bsg_job; struct iscsi_bus_flash_session; struct iscsi_bus_flash_conn; /** * struct iscsi_transport - iSCSI Transport template * * @name: transport name * @caps: iSCSI Data-Path capabilities * @create_session: create new iSCSI session object * @destroy_session: destroy existing iSCSI session object * @create_conn: create new iSCSI connection * @bind_conn: associate this connection with existing iSCSI session * and specified transport descriptor * @destroy_conn: destroy inactive iSCSI connection * @set_param: set iSCSI parameter. Return 0 on success, -ENODATA * when param is not supported, and a -Exx value on other * error. * @get_param get iSCSI parameter. Must return number of bytes * copied to buffer on success, -ENODATA when param * is not supported, and a -Exx value on other error * @start_conn: set connection to be operational * @stop_conn: suspend/recover/terminate connection * @send_pdu: send iSCSI PDU, Login, Logout, NOP-Out, Reject, Text. * @session_recovery_timedout: notify LLD a block during recovery timed out * @init_task: Initialize a iscsi_task and any internal structs. * When offloading the data path, this is called from * queuecommand with the session lock, or from the * iscsi_conn_send_pdu context with the session lock. * When not offloading the data path, this is called * from the scsi work queue without the session lock. * @xmit_task Requests LLD to transfer cmd task. Returns 0 or the * number of bytes transferred on success, and -Exyz * value on error. When offloading the data path, this * is called from queuecommand with the session lock, or * from the iscsi_conn_send_pdu context with the session * lock. When not offloading the data path, this is called * from the scsi work queue without the session lock. * @cleanup_task: requests LLD to fail task. Called with session lock * and after the connection has been suspended and * terminated during recovery. If called * from abort task then connection is not suspended * or terminated but sk_callback_lock is held * * Template API provided by iSCSI Transport */ struct iscsi_transport { … }; /* * transport registration upcalls */ extern struct scsi_transport_template *iscsi_register_transport(struct iscsi_transport *tt); extern void iscsi_unregister_transport(struct iscsi_transport *tt); /* * control plane upcalls */ extern void iscsi_conn_error_event(struct iscsi_cls_conn *conn, enum iscsi_err error); extern void iscsi_conn_login_event(struct iscsi_cls_conn *conn, enum iscsi_conn_state state); extern int iscsi_recv_pdu(struct iscsi_cls_conn *conn, struct iscsi_hdr *hdr, char *data, uint32_t data_size); extern int iscsi_offload_mesg(struct Scsi_Host *shost, struct iscsi_transport *transport, uint32_t type, char *data, uint16_t data_size); extern void iscsi_post_host_event(uint32_t host_no, struct iscsi_transport *transport, enum iscsi_host_event_code code, uint32_t data_size, uint8_t *data); extern void iscsi_ping_comp_event(uint32_t host_no, struct iscsi_transport *transport, uint32_t status, uint32_t pid, uint32_t data_size, uint8_t *data); /* iscsi class connection state */ enum iscsi_connection_state { … }; #define ISCSI_CLS_CONN_BIT_CLEANUP … struct iscsi_cls_conn { … }; #define iscsi_dev_to_conn(_dev) … #define transport_class_to_conn(_cdev) … #define iscsi_conn_to_session(_conn) … /* iscsi class session state */ enum { … }; enum { … }; #define ISCSI_MAX_TARGET … struct iscsi_cls_session { … }; #define iscsi_dev_to_session(_dev) … #define transport_class_to_session(_cdev) … #define iscsi_session_to_shost(_session) … #define starget_to_session(_stgt) … struct iscsi_cls_host { … }; #define iscsi_job_to_shost(_job) … extern void iscsi_host_for_each_session(struct Scsi_Host *shost, void (*fn)(struct iscsi_cls_session *)); struct iscsi_endpoint { … }; struct iscsi_iface { … }; #define iscsi_dev_to_iface(_dev) … #define iscsi_iface_to_shost(_iface) … struct iscsi_bus_flash_conn { … }; #define iscsi_dev_to_flash_conn(_dev) … #define iscsi_flash_conn_to_flash_session(_conn) … #define ISID_SIZE … struct iscsi_bus_flash_session { … }; #define iscsi_dev_to_flash_session(_dev) … #define iscsi_flash_session_to_shost(_session) … /* * session and connection functions that can be used by HW iSCSI LLDs */ #define iscsi_cls_session_printk(prefix, _cls_session, fmt, a...) … #define iscsi_cls_conn_printk(prefix, _cls_conn, fmt, a...) … extern int iscsi_session_chkready(struct iscsi_cls_session *session); extern int iscsi_is_session_online(struct iscsi_cls_session *session); extern struct iscsi_cls_session *iscsi_alloc_session(struct Scsi_Host *shost, struct iscsi_transport *transport, int dd_size); extern int iscsi_add_session(struct iscsi_cls_session *session, unsigned int target_id); extern int iscsi_session_event(struct iscsi_cls_session *session, enum iscsi_uevent_e event); extern struct iscsi_cls_session *iscsi_create_session(struct Scsi_Host *shost, struct iscsi_transport *t, int dd_size, unsigned int target_id); extern void iscsi_force_destroy_session(struct iscsi_cls_session *session); extern void iscsi_remove_session(struct iscsi_cls_session *session); extern void iscsi_free_session(struct iscsi_cls_session *session); extern struct iscsi_cls_conn *iscsi_alloc_conn(struct iscsi_cls_session *sess, int dd_size, uint32_t cid); extern int iscsi_add_conn(struct iscsi_cls_conn *conn); extern void iscsi_remove_conn(struct iscsi_cls_conn *conn); extern void iscsi_put_conn(struct iscsi_cls_conn *conn); extern void iscsi_get_conn(struct iscsi_cls_conn *conn); extern void iscsi_unblock_session(struct iscsi_cls_session *session); extern void iscsi_block_session(struct iscsi_cls_session *session); extern struct iscsi_endpoint *iscsi_create_endpoint(int dd_size); extern void iscsi_destroy_endpoint(struct iscsi_endpoint *ep); extern struct iscsi_endpoint *iscsi_lookup_endpoint(u64 handle); extern void iscsi_put_endpoint(struct iscsi_endpoint *ep); extern int iscsi_block_scsi_eh(struct scsi_cmnd *cmd); extern struct iscsi_iface *iscsi_create_iface(struct Scsi_Host *shost, struct iscsi_transport *t, uint32_t iface_type, uint32_t iface_num, int dd_size); extern void iscsi_destroy_iface(struct iscsi_iface *iface); extern char *iscsi_get_port_speed_name(struct Scsi_Host *shost); extern char *iscsi_get_port_state_name(struct Scsi_Host *shost); extern int iscsi_is_session_dev(const struct device *dev); extern char *iscsi_get_discovery_parent_name(int parent_type); extern struct device * iscsi_find_flashnode(struct Scsi_Host *shost, void *data, int (*fn)(struct device *dev, void *data)); extern struct iscsi_bus_flash_session * iscsi_create_flashnode_sess(struct Scsi_Host *shost, int index, struct iscsi_transport *transport, int dd_size); extern struct iscsi_bus_flash_conn * iscsi_create_flashnode_conn(struct Scsi_Host *shost, struct iscsi_bus_flash_session *fnode_sess, struct iscsi_transport *transport, int dd_size); extern void iscsi_destroy_flashnode_sess(struct iscsi_bus_flash_session *fnode_sess); extern void iscsi_destroy_all_flashnode(struct Scsi_Host *shost); extern int iscsi_flashnode_bus_match(struct device *dev, const struct device_driver *drv); extern struct device * iscsi_find_flashnode_sess(struct Scsi_Host *shost, void *data, int (*fn)(struct device *dev, void *data)); extern struct device * iscsi_find_flashnode_conn(struct iscsi_bus_flash_session *fnode_sess); extern char * iscsi_get_ipaddress_state_name(enum iscsi_ipaddress_state port_state); extern char *iscsi_get_router_state_name(enum iscsi_router_state router_state); #endif
Codebase Browser
linux