Merge tag 'uapi-20121219' into for-linus
UAPI Disintegration 2012-12-19 This is the remaining SCSI part of the UAPI Signed-off-by: James Bottomley <JBottomley@Parallels.com>
This commit is contained in:
James Bottomley
@@ -1,2 +1,5 @@
|
||||
# UAPI Header export list
|
||||
header-y += fc/
|
||||
header-y += scsi_bsg_fc.h
|
||||
header-y += scsi_netlink.h
|
||||
header-y += scsi_netlink_fc.h
|
||||
|
||||
320
include/uapi/scsi/scsi_bsg_fc.h
Normal file
320
include/uapi/scsi/scsi_bsg_fc.h
Normal file
@@ -0,0 +1,320 @@
|
||||
/*
|
||||
* FC Transport BSG Interface
|
||||
*
|
||||
* Copyright (C) 2008 James Smart, Emulex Corporation
|
||||
*
|
||||
* This program is free software; you can redistribute it and/or modify
|
||||
* it under the terms of the GNU General Public License as published by
|
||||
* the Free Software Foundation; either version 2 of the License, or
|
||||
* (at your option) any later version.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU General Public License
|
||||
* along with this program; if not, write to the Free Software
|
||||
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
|
||||
*
|
||||
*/
|
||||
|
||||
#ifndef SCSI_BSG_FC_H
|
||||
#define SCSI_BSG_FC_H
|
||||
|
||||
/*
|
||||
* This file intended to be included by both kernel and user space
|
||||
*/
|
||||
|
||||
/*
|
||||
* FC Transport SGIO v4 BSG Message Support
|
||||
*/
|
||||
|
||||
/* Default BSG request timeout (in seconds) */
|
||||
#define FC_DEFAULT_BSG_TIMEOUT (10 * HZ)
|
||||
|
||||
|
||||
/*
|
||||
* Request Message Codes supported by the FC Transport
|
||||
*/
|
||||
|
||||
/* define the class masks for the message codes */
|
||||
#define FC_BSG_CLS_MASK 0xF0000000 /* find object class */
|
||||
#define FC_BSG_HST_MASK 0x80000000 /* fc host class */
|
||||
#define FC_BSG_RPT_MASK 0x40000000 /* fc rport class */
|
||||
|
||||
/* fc_host Message Codes */
|
||||
#define FC_BSG_HST_ADD_RPORT (FC_BSG_HST_MASK | 0x00000001)
|
||||
#define FC_BSG_HST_DEL_RPORT (FC_BSG_HST_MASK | 0x00000002)
|
||||
#define FC_BSG_HST_ELS_NOLOGIN (FC_BSG_HST_MASK | 0x00000003)
|
||||
#define FC_BSG_HST_CT (FC_BSG_HST_MASK | 0x00000004)
|
||||
#define FC_BSG_HST_VENDOR (FC_BSG_HST_MASK | 0x000000FF)
|
||||
|
||||
/* fc_rport Message Codes */
|
||||
#define FC_BSG_RPT_ELS (FC_BSG_RPT_MASK | 0x00000001)
|
||||
#define FC_BSG_RPT_CT (FC_BSG_RPT_MASK | 0x00000002)
|
||||
|
||||
|
||||
|
||||
/*
|
||||
* FC Address Identifiers in Message Structures :
|
||||
*
|
||||
* Whenever a command payload contains a FC Address Identifier
|
||||
* (aka port_id), the value is effectively in big-endian
|
||||
* order, thus the array elements are decoded as follows:
|
||||
* element [0] is bits 23:16 of the FC Address Identifier
|
||||
* element [1] is bits 15:8 of the FC Address Identifier
|
||||
* element [2] is bits 7:0 of the FC Address Identifier
|
||||
*/
|
||||
|
||||
|
||||
/*
|
||||
* FC Host Messages
|
||||
*/
|
||||
|
||||
/* FC_BSG_HST_ADDR_PORT : */
|
||||
|
||||
/* Request:
|
||||
* This message requests the FC host to login to the remote port
|
||||
* at the specified N_Port_Id. The remote port is to be enumerated
|
||||
* with the transport upon completion of the login.
|
||||
*/
|
||||
struct fc_bsg_host_add_rport {
|
||||
uint8_t reserved;
|
||||
|
||||
/* FC Address Identier of the remote port to login to */
|
||||
uint8_t port_id[3];
|
||||
};
|
||||
|
||||
/* Response:
|
||||
* There is no additional response data - fc_bsg_reply->result is sufficient
|
||||
*/
|
||||
|
||||
|
||||
/* FC_BSG_HST_DEL_RPORT : */
|
||||
|
||||
/* Request:
|
||||
* This message requests the FC host to remove an enumerated
|
||||
* remote port and to terminate the login to it.
|
||||
*
|
||||
* Note: The driver is free to reject this request if it desires to
|
||||
* remain logged in with the remote port.
|
||||
*/
|
||||
struct fc_bsg_host_del_rport {
|
||||
uint8_t reserved;
|
||||
|
||||
/* FC Address Identier of the remote port to logout of */
|
||||
uint8_t port_id[3];
|
||||
};
|
||||
|
||||
/* Response:
|
||||
* There is no additional response data - fc_bsg_reply->result is sufficient
|
||||
*/
|
||||
|
||||
|
||||
/* FC_BSG_HST_ELS_NOLOGIN : */
|
||||
|
||||
/* Request:
|
||||
* This message requests the FC_Host to send an ELS to a specific
|
||||
* N_Port_ID. The host does not need to log into the remote port,
|
||||
* nor does it need to enumerate the rport for further traffic
|
||||
* (although, the FC host is free to do so if it desires).
|
||||
*/
|
||||
struct fc_bsg_host_els {
|
||||
/*
|
||||
* ELS Command Code being sent (must be the same as byte 0
|
||||
* of the payload)
|
||||
*/
|
||||
uint8_t command_code;
|
||||
|
||||
/* FC Address Identier of the remote port to send the ELS to */
|
||||
uint8_t port_id[3];
|
||||
};
|
||||
|
||||
/* Response:
|
||||
*/
|
||||
/* fc_bsg_ctels_reply->status values */
|
||||
#define FC_CTELS_STATUS_OK 0x00000000
|
||||
#define FC_CTELS_STATUS_REJECT 0x00000001
|
||||
#define FC_CTELS_STATUS_P_RJT 0x00000002
|
||||
#define FC_CTELS_STATUS_F_RJT 0x00000003
|
||||
#define FC_CTELS_STATUS_P_BSY 0x00000004
|
||||
#define FC_CTELS_STATUS_F_BSY 0x00000006
|
||||
struct fc_bsg_ctels_reply {
|
||||
/*
|
||||
* Note: An ELS LS_RJT may be reported in 2 ways:
|
||||
* a) A status of FC_CTELS_STATUS_OK is returned. The caller
|
||||
* is to look into the ELS receive payload to determine
|
||||
* LS_ACC or LS_RJT (by contents of word 0). The reject
|
||||
* data will be in word 1.
|
||||
* b) A status of FC_CTELS_STATUS_REJECT is returned, The
|
||||
* rjt_data field will contain valid data.
|
||||
*
|
||||
* Note: ELS LS_ACC is determined by an FC_CTELS_STATUS_OK, and
|
||||
* the receive payload word 0 indicates LS_ACC
|
||||
* (e.g. value is 0x02xxxxxx).
|
||||
*
|
||||
* Note: Similarly, a CT Reject may be reported in 2 ways:
|
||||
* a) A status of FC_CTELS_STATUS_OK is returned. The caller
|
||||
* is to look into the CT receive payload to determine
|
||||
* Accept or Reject (by contents of word 2). The reject
|
||||
* data will be in word 3.
|
||||
* b) A status of FC_CTELS_STATUS_REJECT is returned, The
|
||||
* rjt_data field will contain valid data.
|
||||
*
|
||||
* Note: x_RJT/BSY status will indicae that the rjt_data field
|
||||
* is valid and contains the reason/explanation values.
|
||||
*/
|
||||
uint32_t status; /* See FC_CTELS_STATUS_xxx */
|
||||
|
||||
/* valid if status is not FC_CTELS_STATUS_OK */
|
||||
struct {
|
||||
uint8_t action; /* fragment_id for CT REJECT */
|
||||
uint8_t reason_code;
|
||||
uint8_t reason_explanation;
|
||||
uint8_t vendor_unique;
|
||||
} rjt_data;
|
||||
};
|
||||
|
||||
|
||||
/* FC_BSG_HST_CT : */
|
||||
|
||||
/* Request:
|
||||
* This message requests that a CT Request be performed with the
|
||||
* indicated N_Port_ID. The driver is responsible for logging in with
|
||||
* the fabric and/or N_Port_ID, etc as per FC rules. This request does
|
||||
* not mandate that the driver must enumerate the destination in the
|
||||
* transport. The driver is allowed to decide whether to enumerate it,
|
||||
* and whether to tear it down after the request.
|
||||
*/
|
||||
struct fc_bsg_host_ct {
|
||||
uint8_t reserved;
|
||||
|
||||
/* FC Address Identier of the remote port to send the ELS to */
|
||||
uint8_t port_id[3];
|
||||
|
||||
/*
|
||||
* We need words 0-2 of the generic preamble for the LLD's
|
||||
*/
|
||||
uint32_t preamble_word0; /* revision & IN_ID */
|
||||
uint32_t preamble_word1; /* GS_Type, GS_SubType, Options, Rsvd */
|
||||
uint32_t preamble_word2; /* Cmd Code, Max Size */
|
||||
|
||||
};
|
||||
/* Response:
|
||||
*
|
||||
* The reply structure is an fc_bsg_ctels_reply structure
|
||||
*/
|
||||
|
||||
|
||||
/* FC_BSG_HST_VENDOR : */
|
||||
|
||||
/* Request:
|
||||
* Note: When specifying vendor_id, be sure to read the Vendor Type and ID
|
||||
* formatting requirements specified in scsi_netlink.h
|
||||
*/
|
||||
struct fc_bsg_host_vendor {
|
||||
/*
|
||||
* Identifies the vendor that the message is formatted for. This
|
||||
* should be the recipient of the message.
|
||||
*/
|
||||
uint64_t vendor_id;
|
||||
|
||||
/* start of vendor command area */
|
||||
uint32_t vendor_cmd[0];
|
||||
};
|
||||
|
||||
/* Response:
|
||||
*/
|
||||
struct fc_bsg_host_vendor_reply {
|
||||
/* start of vendor response area */
|
||||
uint32_t vendor_rsp[0];
|
||||
};
|
||||
|
||||
|
||||
|
||||
/*
|
||||
* FC Remote Port Messages
|
||||
*/
|
||||
|
||||
/* FC_BSG_RPT_ELS : */
|
||||
|
||||
/* Request:
|
||||
* This message requests that an ELS be performed with the rport.
|
||||
*/
|
||||
struct fc_bsg_rport_els {
|
||||
/*
|
||||
* ELS Command Code being sent (must be the same as
|
||||
* byte 0 of the payload)
|
||||
*/
|
||||
uint8_t els_code;
|
||||
};
|
||||
|
||||
/* Response:
|
||||
*
|
||||
* The reply structure is an fc_bsg_ctels_reply structure
|
||||
*/
|
||||
|
||||
|
||||
/* FC_BSG_RPT_CT : */
|
||||
|
||||
/* Request:
|
||||
* This message requests that a CT Request be performed with the rport.
|
||||
*/
|
||||
struct fc_bsg_rport_ct {
|
||||
/*
|
||||
* We need words 0-2 of the generic preamble for the LLD's
|
||||
*/
|
||||
uint32_t preamble_word0; /* revision & IN_ID */
|
||||
uint32_t preamble_word1; /* GS_Type, GS_SubType, Options, Rsvd */
|
||||
uint32_t preamble_word2; /* Cmd Code, Max Size */
|
||||
};
|
||||
/* Response:
|
||||
*
|
||||
* The reply structure is an fc_bsg_ctels_reply structure
|
||||
*/
|
||||
|
||||
|
||||
|
||||
|
||||
/* request (CDB) structure of the sg_io_v4 */
|
||||
struct fc_bsg_request {
|
||||
uint32_t msgcode;
|
||||
union {
|
||||
struct fc_bsg_host_add_rport h_addrport;
|
||||
struct fc_bsg_host_del_rport h_delrport;
|
||||
struct fc_bsg_host_els h_els;
|
||||
struct fc_bsg_host_ct h_ct;
|
||||
struct fc_bsg_host_vendor h_vendor;
|
||||
|
||||
struct fc_bsg_rport_els r_els;
|
||||
struct fc_bsg_rport_ct r_ct;
|
||||
} rqst_data;
|
||||
} __attribute__((packed));
|
||||
|
||||
|
||||
/* response (request sense data) structure of the sg_io_v4 */
|
||||
struct fc_bsg_reply {
|
||||
/*
|
||||
* The completion result. Result exists in two forms:
|
||||
* if negative, it is an -Exxx system errno value. There will
|
||||
* be no further reply information supplied.
|
||||
* else, it's the 4-byte scsi error result, with driver, host,
|
||||
* msg and status fields. The per-msgcode reply structure
|
||||
* will contain valid data.
|
||||
*/
|
||||
uint32_t result;
|
||||
|
||||
/* If there was reply_payload, how much was recevied ? */
|
||||
uint32_t reply_payload_rcv_len;
|
||||
|
||||
union {
|
||||
struct fc_bsg_host_vendor_reply vendor_reply;
|
||||
|
||||
struct fc_bsg_ctels_reply ctels_reply;
|
||||
} reply_data;
|
||||
};
|
||||
|
||||
|
||||
#endif /* SCSI_BSG_FC_H */
|
||||
|
||||
123
include/uapi/scsi/scsi_netlink.h
Normal file
123
include/uapi/scsi/scsi_netlink.h
Normal file
@@ -0,0 +1,123 @@
|
||||
/*
|
||||
* SCSI Transport Netlink Interface
|
||||
* Used for the posting of outbound SCSI transport events
|
||||
*
|
||||
* Copyright (C) 2006 James Smart, Emulex Corporation
|
||||
*
|
||||
* This program is free software; you can redistribute it and/or modify
|
||||
* it under the terms of the GNU General Public License as published by
|
||||
* the Free Software Foundation; either version 2 of the License, or
|
||||
* (at your option) any later version.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU General Public License
|
||||
* along with this program; if not, write to the Free Software
|
||||
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
|
||||
*
|
||||
*/
|
||||
#ifndef SCSI_NETLINK_H
|
||||
#define SCSI_NETLINK_H
|
||||
|
||||
#include <linux/netlink.h>
|
||||
#include <linux/types.h>
|
||||
|
||||
/*
|
||||
* This file intended to be included by both kernel and user space
|
||||
*/
|
||||
|
||||
/* Single Netlink Message type to send all SCSI Transport messages */
|
||||
#define SCSI_TRANSPORT_MSG NLMSG_MIN_TYPE + 1
|
||||
|
||||
/* SCSI Transport Broadcast Groups */
|
||||
/* leaving groups 0 and 1 unassigned */
|
||||
#define SCSI_NL_GRP_FC_EVENTS (1<<2) /* Group 2 */
|
||||
#define SCSI_NL_GRP_CNT 3
|
||||
|
||||
|
||||
/* SCSI_TRANSPORT_MSG event message header */
|
||||
struct scsi_nl_hdr {
|
||||
uint8_t version;
|
||||
uint8_t transport;
|
||||
uint16_t magic;
|
||||
uint16_t msgtype;
|
||||
uint16_t msglen;
|
||||
} __attribute__((aligned(sizeof(uint64_t))));
|
||||
|
||||
/* scsi_nl_hdr->version value */
|
||||
#define SCSI_NL_VERSION 1
|
||||
|
||||
/* scsi_nl_hdr->magic value */
|
||||
#define SCSI_NL_MAGIC 0xA1B2
|
||||
|
||||
/* scsi_nl_hdr->transport value */
|
||||
#define SCSI_NL_TRANSPORT 0
|
||||
#define SCSI_NL_TRANSPORT_FC 1
|
||||
#define SCSI_NL_MAX_TRANSPORTS 2
|
||||
|
||||
/* Transport-based scsi_nl_hdr->msgtype values are defined in each transport */
|
||||
|
||||
/*
|
||||
* GENERIC SCSI scsi_nl_hdr->msgtype Values
|
||||
*/
|
||||
/* kernel -> user */
|
||||
#define SCSI_NL_SHOST_VENDOR 0x0001
|
||||
/* user -> kernel */
|
||||
/* SCSI_NL_SHOST_VENDOR msgtype is kernel->user and user->kernel */
|
||||
|
||||
|
||||
/*
|
||||
* Message Structures :
|
||||
*/
|
||||
|
||||
/* macro to round up message lengths to 8byte boundary */
|
||||
#define SCSI_NL_MSGALIGN(len) (((len) + 7) & ~7)
|
||||
|
||||
|
||||
/*
|
||||
* SCSI HOST Vendor Unique messages :
|
||||
* SCSI_NL_SHOST_VENDOR
|
||||
*
|
||||
* Note: The Vendor Unique message payload will begin directly after
|
||||
* this structure, with the length of the payload per vmsg_datalen.
|
||||
*
|
||||
* Note: When specifying vendor_id, be sure to read the Vendor Type and ID
|
||||
* formatting requirements specified below
|
||||
*/
|
||||
struct scsi_nl_host_vendor_msg {
|
||||
struct scsi_nl_hdr snlh; /* must be 1st element ! */
|
||||
uint64_t vendor_id;
|
||||
uint16_t host_no;
|
||||
uint16_t vmsg_datalen;
|
||||
} __attribute__((aligned(sizeof(uint64_t))));
|
||||
|
||||
|
||||
/*
|
||||
* Vendor ID:
|
||||
* If transports post vendor-unique events, they must pass a well-known
|
||||
* 32-bit vendor identifier. This identifier consists of 8 bits indicating
|
||||
* the "type" of identifier contained, and 24 bits of id data.
|
||||
*
|
||||
* Identifiers for each type:
|
||||
* PCI : ID data is the 16 bit PCI Registered Vendor ID
|
||||
*/
|
||||
#define SCSI_NL_VID_TYPE_SHIFT 56
|
||||
#define SCSI_NL_VID_TYPE_MASK ((__u64)0xFF << SCSI_NL_VID_TYPE_SHIFT)
|
||||
#define SCSI_NL_VID_TYPE_PCI ((__u64)0x01 << SCSI_NL_VID_TYPE_SHIFT)
|
||||
#define SCSI_NL_VID_ID_MASK (~ SCSI_NL_VID_TYPE_MASK)
|
||||
|
||||
|
||||
#define INIT_SCSI_NL_HDR(hdr, t, mtype, mlen) \
|
||||
{ \
|
||||
(hdr)->version = SCSI_NL_VERSION; \
|
||||
(hdr)->transport = t; \
|
||||
(hdr)->magic = SCSI_NL_MAGIC; \
|
||||
(hdr)->msgtype = mtype; \
|
||||
(hdr)->msglen = mlen; \
|
||||
}
|
||||
|
||||
#endif /* SCSI_NETLINK_H */
|
||||
|
||||
71
include/uapi/scsi/scsi_netlink_fc.h
Normal file
71
include/uapi/scsi/scsi_netlink_fc.h
Normal file
@@ -0,0 +1,71 @@
|
||||
/*
|
||||
* FC Transport Netlink Interface
|
||||
*
|
||||
* Copyright (C) 2006 James Smart, Emulex Corporation
|
||||
*
|
||||
* This program is free software; you can redistribute it and/or modify
|
||||
* it under the terms of the GNU General Public License as published by
|
||||
* the Free Software Foundation; either version 2 of the License, or
|
||||
* (at your option) any later version.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU General Public License
|
||||
* along with this program; if not, write to the Free Software
|
||||
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
|
||||
*
|
||||
*/
|
||||
#ifndef SCSI_NETLINK_FC_H
|
||||
#define SCSI_NETLINK_FC_H
|
||||
|
||||
#include <scsi/scsi_netlink.h>
|
||||
|
||||
/*
|
||||
* This file intended to be included by both kernel and user space
|
||||
*/
|
||||
|
||||
/*
|
||||
* FC Transport Message Types
|
||||
*/
|
||||
/* kernel -> user */
|
||||
#define FC_NL_ASYNC_EVENT 0x0100
|
||||
/* user -> kernel */
|
||||
/* none */
|
||||
|
||||
|
||||
/*
|
||||
* Message Structures :
|
||||
*/
|
||||
|
||||
/* macro to round up message lengths to 8byte boundary */
|
||||
#define FC_NL_MSGALIGN(len) (((len) + 7) & ~7)
|
||||
|
||||
|
||||
/*
|
||||
* FC Transport Broadcast Event Message :
|
||||
* FC_NL_ASYNC_EVENT
|
||||
*
|
||||
* Note: if Vendor Unique message, &event_data will be start of
|
||||
* vendor unique payload, and the length of the payload is
|
||||
* per event_datalen
|
||||
*
|
||||
* Note: When specifying vendor_id, be sure to read the Vendor Type and ID
|
||||
* formatting requirements specified in scsi_netlink.h
|
||||
*/
|
||||
struct fc_nl_event {
|
||||
struct scsi_nl_hdr snlh; /* must be 1st element ! */
|
||||
uint64_t seconds;
|
||||
uint64_t vendor_id;
|
||||
uint16_t host_no;
|
||||
uint16_t event_datalen;
|
||||
uint32_t event_num;
|
||||
uint32_t event_code;
|
||||
uint32_t event_data;
|
||||
} __attribute__((aligned(sizeof(uint64_t))));
|
||||
|
||||
|
||||
#endif /* SCSI_NETLINK_FC_H */
|
||||
|
||||
Reference in New Issue
Block a user