mirror of
https://github.com/torvalds/linux.git
synced 2024-11-19 02:21:47 +00:00
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>
268 lines
8.8 KiB
C
268 lines
8.8 KiB
C
/* SPDX-License-Identifier: ((GPL-2.0 WITH Linux-syscall-note) OR BSD-3-Clause) */
|
|
/*
|
|
*
|
|
* This file is provided under a dual BSD/GPLv2 license. When using or
|
|
* redistributing this file, you may do so under either license.
|
|
*
|
|
* GPL LICENSE SUMMARY
|
|
*
|
|
* Copyright(c) 2015 Intel Corporation.
|
|
*
|
|
* This program is free software; you can redistribute it and/or modify
|
|
* it under the terms of version 2 of the GNU General Public License as
|
|
* published by the Free Software Foundation.
|
|
*
|
|
* 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.
|
|
*
|
|
* BSD LICENSE
|
|
*
|
|
* Copyright(c) 2015 Intel Corporation.
|
|
*
|
|
* Redistribution and use in source and binary forms, with or without
|
|
* modification, are permitted provided that the following conditions
|
|
* are met:
|
|
*
|
|
* - Redistributions of source code must retain the above copyright
|
|
* notice, this list of conditions and the following disclaimer.
|
|
* - Redistributions in binary form must reproduce the above copyright
|
|
* notice, this list of conditions and the following disclaimer in
|
|
* the documentation and/or other materials provided with the
|
|
* distribution.
|
|
* - Neither the name of Intel Corporation nor the names of its
|
|
* contributors may be used to endorse or promote products derived
|
|
* from this software without specific prior written permission.
|
|
*
|
|
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
|
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
|
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
|
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
|
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
|
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
|
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
|
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
|
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
|
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
|
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
*
|
|
*/
|
|
|
|
/*
|
|
* This file contains defines, structures, etc. that are used
|
|
* to communicate between kernel and user code.
|
|
*/
|
|
|
|
#ifndef _LINUX__HFI1_USER_H
|
|
#define _LINUX__HFI1_USER_H
|
|
|
|
#include <linux/types.h>
|
|
#include <rdma/rdma_user_ioctl.h>
|
|
|
|
/*
|
|
* This version number is given to the driver by the user code during
|
|
* initialization in the spu_userversion field of hfi1_user_info, so
|
|
* the driver can check for compatibility with user code.
|
|
*
|
|
* The major version changes when data structures change in an incompatible
|
|
* way. The driver must be the same for initialization to succeed.
|
|
*/
|
|
#define HFI1_USER_SWMAJOR 6
|
|
|
|
/*
|
|
* Minor version differences are always compatible
|
|
* a within a major version, however if user software is larger
|
|
* than driver software, some new features and/or structure fields
|
|
* may not be implemented; the user code must deal with this if it
|
|
* cares, or it must abort after initialization reports the difference.
|
|
*/
|
|
#define HFI1_USER_SWMINOR 3
|
|
|
|
/*
|
|
* We will encode the major/minor inside a single 32bit version number.
|
|
*/
|
|
#define HFI1_SWMAJOR_SHIFT 16
|
|
|
|
/*
|
|
* Set of HW and driver capability/feature bits.
|
|
* These bit values are used to configure enabled/disabled HW and
|
|
* driver features. The same set of bits are communicated to user
|
|
* space.
|
|
*/
|
|
#define HFI1_CAP_DMA_RTAIL (1UL << 0) /* Use DMA'ed RTail value */
|
|
#define HFI1_CAP_SDMA (1UL << 1) /* Enable SDMA support */
|
|
#define HFI1_CAP_SDMA_AHG (1UL << 2) /* Enable SDMA AHG support */
|
|
#define HFI1_CAP_EXTENDED_PSN (1UL << 3) /* Enable Extended PSN support */
|
|
#define HFI1_CAP_HDRSUPP (1UL << 4) /* Enable Header Suppression */
|
|
/* 1UL << 5 unused */
|
|
#define HFI1_CAP_USE_SDMA_HEAD (1UL << 6) /* DMA Hdr Q tail vs. use CSR */
|
|
#define HFI1_CAP_MULTI_PKT_EGR (1UL << 7) /* Enable multi-packet Egr buffs*/
|
|
#define HFI1_CAP_NODROP_RHQ_FULL (1UL << 8) /* Don't drop on Hdr Q full */
|
|
#define HFI1_CAP_NODROP_EGR_FULL (1UL << 9) /* Don't drop on EGR buffs full */
|
|
#define HFI1_CAP_TID_UNMAP (1UL << 10) /* Disable Expected TID caching */
|
|
#define HFI1_CAP_PRINT_UNIMPL (1UL << 11) /* Show for unimplemented feats */
|
|
#define HFI1_CAP_ALLOW_PERM_JKEY (1UL << 12) /* Allow use of permissive JKEY */
|
|
#define HFI1_CAP_NO_INTEGRITY (1UL << 13) /* Enable ctxt integrity checks */
|
|
#define HFI1_CAP_PKEY_CHECK (1UL << 14) /* Enable ctxt PKey checking */
|
|
#define HFI1_CAP_STATIC_RATE_CTRL (1UL << 15) /* Allow PBC.StaticRateControl */
|
|
/* 1UL << 16 unused */
|
|
#define HFI1_CAP_SDMA_HEAD_CHECK (1UL << 17) /* SDMA head checking */
|
|
#define HFI1_CAP_EARLY_CREDIT_RETURN (1UL << 18) /* early credit return */
|
|
|
|
#define HFI1_RCVHDR_ENTSIZE_2 (1UL << 0)
|
|
#define HFI1_RCVHDR_ENTSIZE_16 (1UL << 1)
|
|
#define HFI1_RCVDHR_ENTSIZE_32 (1UL << 2)
|
|
|
|
#define _HFI1_EVENT_FROZEN_BIT 0
|
|
#define _HFI1_EVENT_LINKDOWN_BIT 1
|
|
#define _HFI1_EVENT_LID_CHANGE_BIT 2
|
|
#define _HFI1_EVENT_LMC_CHANGE_BIT 3
|
|
#define _HFI1_EVENT_SL2VL_CHANGE_BIT 4
|
|
#define _HFI1_EVENT_TID_MMU_NOTIFY_BIT 5
|
|
#define _HFI1_MAX_EVENT_BIT _HFI1_EVENT_TID_MMU_NOTIFY_BIT
|
|
|
|
#define HFI1_EVENT_FROZEN (1UL << _HFI1_EVENT_FROZEN_BIT)
|
|
#define HFI1_EVENT_LINKDOWN (1UL << _HFI1_EVENT_LINKDOWN_BIT)
|
|
#define HFI1_EVENT_LID_CHANGE (1UL << _HFI1_EVENT_LID_CHANGE_BIT)
|
|
#define HFI1_EVENT_LMC_CHANGE (1UL << _HFI1_EVENT_LMC_CHANGE_BIT)
|
|
#define HFI1_EVENT_SL2VL_CHANGE (1UL << _HFI1_EVENT_SL2VL_CHANGE_BIT)
|
|
#define HFI1_EVENT_TID_MMU_NOTIFY (1UL << _HFI1_EVENT_TID_MMU_NOTIFY_BIT)
|
|
|
|
/*
|
|
* These are the status bits readable (in ASCII form, 64bit value)
|
|
* from the "status" sysfs file. For binary compatibility, values
|
|
* must remain as is; removed states can be reused for different
|
|
* purposes.
|
|
*/
|
|
#define HFI1_STATUS_INITTED 0x1 /* basic initialization done */
|
|
/* Chip has been found and initialized */
|
|
#define HFI1_STATUS_CHIP_PRESENT 0x20
|
|
/* IB link is at ACTIVE, usable for data traffic */
|
|
#define HFI1_STATUS_IB_READY 0x40
|
|
/* link is configured, LID, MTU, etc. have been set */
|
|
#define HFI1_STATUS_IB_CONF 0x80
|
|
/* A Fatal hardware error has occurred. */
|
|
#define HFI1_STATUS_HWERROR 0x200
|
|
|
|
/*
|
|
* Number of supported shared contexts.
|
|
* This is the maximum number of software contexts that can share
|
|
* a hardware send/receive context.
|
|
*/
|
|
#define HFI1_MAX_SHARED_CTXTS 8
|
|
|
|
/*
|
|
* Poll types
|
|
*/
|
|
#define HFI1_POLL_TYPE_ANYRCV 0x0
|
|
#define HFI1_POLL_TYPE_URGENT 0x1
|
|
|
|
enum hfi1_sdma_comp_state {
|
|
FREE = 0,
|
|
QUEUED,
|
|
COMPLETE,
|
|
ERROR
|
|
};
|
|
|
|
/*
|
|
* SDMA completion ring entry
|
|
*/
|
|
struct hfi1_sdma_comp_entry {
|
|
__u32 status;
|
|
__u32 errcode;
|
|
};
|
|
|
|
/*
|
|
* Device status and notifications from driver to user-space.
|
|
*/
|
|
struct hfi1_status {
|
|
__u64 dev; /* device/hw status bits */
|
|
__u64 port; /* port state and status bits */
|
|
char freezemsg[0];
|
|
};
|
|
|
|
enum sdma_req_opcode {
|
|
EXPECTED = 0,
|
|
EAGER
|
|
};
|
|
|
|
#define HFI1_SDMA_REQ_VERSION_MASK 0xF
|
|
#define HFI1_SDMA_REQ_VERSION_SHIFT 0x0
|
|
#define HFI1_SDMA_REQ_OPCODE_MASK 0xF
|
|
#define HFI1_SDMA_REQ_OPCODE_SHIFT 0x4
|
|
#define HFI1_SDMA_REQ_IOVCNT_MASK 0xFF
|
|
#define HFI1_SDMA_REQ_IOVCNT_SHIFT 0x8
|
|
|
|
struct sdma_req_info {
|
|
/*
|
|
* bits 0-3 - version (currently unused)
|
|
* bits 4-7 - opcode (enum sdma_req_opcode)
|
|
* bits 8-15 - io vector count
|
|
*/
|
|
__u16 ctrl;
|
|
/*
|
|
* Number of fragments contained in this request.
|
|
* User-space has already computed how many
|
|
* fragment-sized packet the user buffer will be
|
|
* split into.
|
|
*/
|
|
__u16 npkts;
|
|
/*
|
|
* Size of each fragment the user buffer will be
|
|
* split into.
|
|
*/
|
|
__u16 fragsize;
|
|
/*
|
|
* Index of the slot in the SDMA completion ring
|
|
* this request should be using. User-space is
|
|
* in charge of managing its own ring.
|
|
*/
|
|
__u16 comp_idx;
|
|
} __packed;
|
|
|
|
/*
|
|
* SW KDETH header.
|
|
* swdata is SW defined portion.
|
|
*/
|
|
struct hfi1_kdeth_header {
|
|
__le32 ver_tid_offset;
|
|
__le16 jkey;
|
|
__le16 hcrc;
|
|
__le32 swdata[7];
|
|
} __packed;
|
|
|
|
/*
|
|
* Structure describing the headers that User space uses. The
|
|
* structure above is a subset of this one.
|
|
*/
|
|
struct hfi1_pkt_header {
|
|
__le16 pbc[4];
|
|
__be16 lrh[4];
|
|
__be32 bth[3];
|
|
struct hfi1_kdeth_header kdeth;
|
|
} __packed;
|
|
|
|
|
|
/*
|
|
* The list of usermode accessible registers.
|
|
*/
|
|
enum hfi1_ureg {
|
|
/* (RO) DMA RcvHdr to be used next. */
|
|
ur_rcvhdrtail = 0,
|
|
/* (RW) RcvHdr entry to be processed next by host. */
|
|
ur_rcvhdrhead = 1,
|
|
/* (RO) Index of next Eager index to use. */
|
|
ur_rcvegrindextail = 2,
|
|
/* (RW) Eager TID to be processed next */
|
|
ur_rcvegrindexhead = 3,
|
|
/* (RO) Receive Eager Offset Tail */
|
|
ur_rcvegroffsettail = 4,
|
|
/* For internal use only; max register number. */
|
|
ur_maxreg,
|
|
/* (RW) Receive TID flow table */
|
|
ur_rcvtidflowtable = 256
|
|
};
|
|
|
|
#endif /* _LINIUX__HFI1_USER_H */
|