e2be04c7f9
Many user space API headers have licensing information, which is either
incomplete, badly formatted or just a shorthand for referring to the
license under which the file is supposed to be. This makes it hard for
compliance tools to determine the correct license.
Update these files with an SPDX license identifier. The identifier was
chosen based on the license information in the file.
GPL/LGPL licensed headers get the matching GPL/LGPL SPDX license
identifier with the added 'WITH Linux-syscall-note' exception, which is
the officially assigned exception identifier for the kernel syscall
exception:
NOTE! This copyright does *not* cover user programs that use kernel
services by normal system calls - this is merely considered normal use
of the kernel, and does *not* fall under the heading of "derived work".
This exception makes it possible to include GPL headers into non GPL
code, without confusing license compliance tools.
Headers which have either explicit dual licensing or are just licensed
under a non GPL license are updated with the corresponding SPDX
identifier and the GPLv2 with syscall exception identifier. The format
is:
((GPL-2.0 WITH Linux-syscall-note) OR SPDX-ID-OF-OTHER-LICENSE)
SPDX license identifiers are a legally binding shorthand, which can be
used instead of the full boiler plate text. The update does not remove
existing license information as this has to be done on a case by case
basis and the copyright holders might have to be consulted. This will
happen in a separate step.
This patch is based on work done by Thomas Gleixner and Kate Stewart and
Philippe Ombredanne. See the previous patch in this series for the
methodology of how this patch was researched.
Reviewed-by: Kate Stewart <kstewart@linuxfoundation.org>
Reviewed-by: Philippe Ombredanne <pombredanne@nexb.com>
Reviewed-by: Thomas Gleixner <tglx@linutronix.de>
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
125 lines
3.6 KiB
C
125 lines
3.6 KiB
C
/* SPDX-License-Identifier: GPL-2.0+ WITH Linux-syscall-note */
|
|
/*
|
|
* 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 */
|
|
|