ebda8d9db8
Mainly focus on files that use BSD 3-Clause license. The Software Package Data Exchange (SPDX) group provides a specification to make it easier for automated tools to detect and summarize well known opensource licenses. We are gradually adopting the specification, noting that the tags are considered only advisory and do not, in any way, superceed or replace the license texts. Special thanks to Wind River for providing access to "The Duke of Highlander" tool: an older (2014) run over FreeBSD tree was useful as a starting point.
391 lines
11 KiB
C
391 lines
11 KiB
C
/*-
|
|
* SPDX-License-Identifier: BSD-3-Clause
|
|
*
|
|
* Copyright (c) 2008 Yahoo!, Inc.
|
|
* All rights reserved.
|
|
* Written by: John Baldwin <jhb@FreeBSD.org>
|
|
*
|
|
* Redistribution and use in source and binary forms, with or without
|
|
* modification, are permitted provided that the following conditions
|
|
* are met:
|
|
* 1. Redistributions of source code must retain the above copyright
|
|
* notice, this list of conditions and the following disclaimer.
|
|
* 2. 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.
|
|
* 3. Neither the name of the author nor the names of any co-contributors
|
|
* may be used to endorse or promote products derived from this software
|
|
* without specific prior written permission.
|
|
*
|
|
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR 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 AUTHOR 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.
|
|
*
|
|
* Avago Technologies (LSI) MPT-Fusion Host Adapter FreeBSD userland interface
|
|
*
|
|
* $FreeBSD$
|
|
*/
|
|
/*-
|
|
* Copyright (c) 2011-2015 LSI Corp.
|
|
* Copyright (c) 2013-2015 Avago Technologies
|
|
* All rights reserved.
|
|
*
|
|
* Redistribution and use in source and binary forms, with or without
|
|
* modification, are permitted provided that the following conditions
|
|
* are met:
|
|
* 1. Redistributions of source code must retain the above copyright
|
|
* notice, this list of conditions and the following disclaimer.
|
|
* 2. 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.
|
|
*
|
|
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR 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 AUTHOR 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.
|
|
*
|
|
* Avago Technologies (LSI) MPT-Fusion Host Adapter FreeBSD
|
|
*
|
|
* $FreeBSD$
|
|
*/
|
|
|
|
#ifndef _MPS_IOCTL_H_
|
|
#define _MPS_IOCTL_H_
|
|
|
|
#include <dev/mps/mpi/mpi2_type.h>
|
|
#include <dev/mps/mpi/mpi2.h>
|
|
#include <dev/mps/mpi/mpi2_cnfg.h>
|
|
#include <dev/mps/mpi/mpi2_sas.h>
|
|
|
|
/*
|
|
* For the read header requests, the header should include the page
|
|
* type or extended page type, page number, and page version. The
|
|
* buffer and length are unused. The completed header is returned in
|
|
* the 'header' member.
|
|
*
|
|
* For the read page and write page requests, 'buf' should point to a
|
|
* buffer of 'len' bytes which holds the entire page (including the
|
|
* header).
|
|
*
|
|
* All requests specify the page address in 'page_address'.
|
|
*/
|
|
struct mps_cfg_page_req {
|
|
MPI2_CONFIG_PAGE_HEADER header;
|
|
uint32_t page_address;
|
|
void *buf;
|
|
int len;
|
|
uint16_t ioc_status;
|
|
};
|
|
|
|
struct mps_ext_cfg_page_req {
|
|
MPI2_CONFIG_EXTENDED_PAGE_HEADER header;
|
|
uint32_t page_address;
|
|
void *buf;
|
|
int len;
|
|
uint16_t ioc_status;
|
|
};
|
|
|
|
struct mps_raid_action {
|
|
uint8_t action;
|
|
uint8_t volume_bus;
|
|
uint8_t volume_id;
|
|
uint8_t phys_disk_num;
|
|
uint32_t action_data_word;
|
|
void *buf;
|
|
int len;
|
|
uint32_t volume_status;
|
|
uint32_t action_data[4];
|
|
uint16_t action_status;
|
|
uint16_t ioc_status;
|
|
uint8_t write;
|
|
};
|
|
|
|
struct mps_usr_command {
|
|
void *req;
|
|
uint32_t req_len;
|
|
void *rpl;
|
|
uint32_t rpl_len;
|
|
void *buf;
|
|
int len;
|
|
uint32_t flags;
|
|
};
|
|
|
|
typedef struct mps_pci_bits
|
|
{
|
|
union {
|
|
struct {
|
|
uint32_t DeviceNumber :5;
|
|
uint32_t FunctionNumber :3;
|
|
uint32_t BusNumber :24;
|
|
} bits;
|
|
uint32_t AsDWORD;
|
|
} u;
|
|
uint32_t PciSegmentId;
|
|
} mps_pci_bits_t;
|
|
|
|
/*
|
|
* The following is the MPSIOCTL_GET_ADAPTER_DATA data structure. This data
|
|
* structure is setup so that we hopefully are properly aligned for both
|
|
* 32-bit and 64-bit mode applications.
|
|
*
|
|
* Adapter Type - Value = 4 = SCSI Protocol through SAS-2 adapter
|
|
*
|
|
* MPI Port Number - The PCI Function number for this device
|
|
*
|
|
* PCI Device HW Id - The PCI device number for this device
|
|
*
|
|
*/
|
|
#define MPSIOCTL_ADAPTER_TYPE_SAS2 4
|
|
#define MPSIOCTL_ADAPTER_TYPE_SAS2_SSS6200 5
|
|
typedef struct mps_adapter_data
|
|
{
|
|
uint32_t StructureLength;
|
|
uint32_t AdapterType;
|
|
uint32_t MpiPortNumber;
|
|
uint32_t PCIDeviceHwId;
|
|
uint32_t PCIDeviceHwRev;
|
|
uint32_t SubSystemId;
|
|
uint32_t SubsystemVendorId;
|
|
uint32_t Reserved1;
|
|
uint32_t MpiFirmwareVersion;
|
|
uint32_t BiosVersion;
|
|
uint8_t DriverVersion[32];
|
|
uint8_t Reserved2;
|
|
uint8_t ScsiId;
|
|
uint16_t Reserved3;
|
|
mps_pci_bits_t PciInformation;
|
|
} mps_adapter_data_t;
|
|
|
|
|
|
typedef struct mps_update_flash
|
|
{
|
|
uint64_t PtrBuffer;
|
|
uint32_t ImageChecksum;
|
|
uint32_t ImageOffset;
|
|
uint32_t ImageSize;
|
|
uint32_t ImageType;
|
|
} mps_update_flash_t;
|
|
|
|
|
|
#define MPS_PASS_THRU_DIRECTION_NONE 0
|
|
#define MPS_PASS_THRU_DIRECTION_READ 1
|
|
#define MPS_PASS_THRU_DIRECTION_WRITE 2
|
|
#define MPS_PASS_THRU_DIRECTION_BOTH 3
|
|
|
|
typedef struct mps_pass_thru
|
|
{
|
|
uint64_t PtrRequest;
|
|
uint64_t PtrReply;
|
|
uint64_t PtrData;
|
|
uint32_t RequestSize;
|
|
uint32_t ReplySize;
|
|
uint32_t DataSize;
|
|
uint32_t DataDirection;
|
|
uint64_t PtrDataOut;
|
|
uint32_t DataOutSize;
|
|
uint32_t Timeout;
|
|
} mps_pass_thru_t;
|
|
|
|
|
|
/*
|
|
* Event queue defines
|
|
*/
|
|
#define MPS_EVENT_QUEUE_SIZE (50) /* Max Events stored in driver */
|
|
#define MPS_MAX_EVENT_DATA_LENGTH (48) /* Size of each event in Dwords */
|
|
|
|
typedef struct mps_event_query
|
|
{
|
|
uint16_t Entries;
|
|
uint16_t Reserved;
|
|
uint32_t Types[4];
|
|
} mps_event_query_t;
|
|
|
|
typedef struct mps_event_enable
|
|
{
|
|
uint32_t Types[4];
|
|
} mps_event_enable_t;
|
|
|
|
/*
|
|
* Event record entry for ioctl.
|
|
*/
|
|
typedef struct mps_event_entry
|
|
{
|
|
uint32_t Type;
|
|
uint32_t Number;
|
|
uint32_t Data[MPS_MAX_EVENT_DATA_LENGTH];
|
|
} mps_event_entry_t;
|
|
|
|
typedef struct mps_event_report
|
|
{
|
|
uint32_t Size;
|
|
uint64_t PtrEvents;
|
|
} mps_event_report_t;
|
|
|
|
|
|
typedef struct mps_pci_info
|
|
{
|
|
uint32_t BusNumber;
|
|
uint8_t DeviceNumber;
|
|
uint8_t FunctionNumber;
|
|
uint16_t InterruptVector;
|
|
uint8_t PciHeader[256];
|
|
} mps_pci_info_t;
|
|
|
|
|
|
typedef struct mps_diag_action
|
|
{
|
|
uint32_t Action;
|
|
uint32_t Length;
|
|
uint64_t PtrDiagAction;
|
|
uint32_t ReturnCode;
|
|
} mps_diag_action_t;
|
|
|
|
#define MPS_FW_DIAGNOSTIC_UID_NOT_FOUND (0xFF)
|
|
|
|
#define MPS_FW_DIAG_NEW (0x806E6577)
|
|
|
|
#define MPS_FW_DIAG_TYPE_REGISTER (0x00000001)
|
|
#define MPS_FW_DIAG_TYPE_UNREGISTER (0x00000002)
|
|
#define MPS_FW_DIAG_TYPE_QUERY (0x00000003)
|
|
#define MPS_FW_DIAG_TYPE_READ_BUFFER (0x00000004)
|
|
#define MPS_FW_DIAG_TYPE_RELEASE (0x00000005)
|
|
|
|
#define MPS_FW_DIAG_INVALID_UID (0x00000000)
|
|
|
|
#define MPS_DIAG_SUCCESS 0
|
|
#define MPS_DIAG_FAILURE 1
|
|
|
|
#define MPS_FW_DIAG_ERROR_SUCCESS (0x00000000)
|
|
#define MPS_FW_DIAG_ERROR_FAILURE (0x00000001)
|
|
#define MPS_FW_DIAG_ERROR_INVALID_PARAMETER (0x00000002)
|
|
#define MPS_FW_DIAG_ERROR_POST_FAILED (0x00000010)
|
|
#define MPS_FW_DIAG_ERROR_INVALID_UID (0x00000011)
|
|
#define MPS_FW_DIAG_ERROR_RELEASE_FAILED (0x00000012)
|
|
#define MPS_FW_DIAG_ERROR_NO_BUFFER (0x00000013)
|
|
#define MPS_FW_DIAG_ERROR_ALREADY_RELEASED (0x00000014)
|
|
|
|
|
|
typedef struct mps_fw_diag_register
|
|
{
|
|
uint8_t ExtendedType;
|
|
uint8_t BufferType;
|
|
uint16_t ApplicationFlags;
|
|
uint32_t DiagnosticFlags;
|
|
uint32_t ProductSpecific[23];
|
|
uint32_t RequestedBufferSize;
|
|
uint32_t UniqueId;
|
|
} mps_fw_diag_register_t;
|
|
|
|
typedef struct mps_fw_diag_unregister
|
|
{
|
|
uint32_t UniqueId;
|
|
} mps_fw_diag_unregister_t;
|
|
|
|
#define MPS_FW_DIAG_FLAG_APP_OWNED (0x0001)
|
|
#define MPS_FW_DIAG_FLAG_BUFFER_VALID (0x0002)
|
|
#define MPS_FW_DIAG_FLAG_FW_BUFFER_ACCESS (0x0004)
|
|
|
|
typedef struct mps_fw_diag_query
|
|
{
|
|
uint8_t ExtendedType;
|
|
uint8_t BufferType;
|
|
uint16_t ApplicationFlags;
|
|
uint32_t DiagnosticFlags;
|
|
uint32_t ProductSpecific[23];
|
|
uint32_t TotalBufferSize;
|
|
uint32_t DriverAddedBufferSize;
|
|
uint32_t UniqueId;
|
|
} mps_fw_diag_query_t;
|
|
|
|
typedef struct mps_fw_diag_release
|
|
{
|
|
uint32_t UniqueId;
|
|
} mps_fw_diag_release_t;
|
|
|
|
#define MPS_FW_DIAG_FLAG_REREGISTER (0x0001)
|
|
#define MPS_FW_DIAG_FLAG_FORCE_RELEASE (0x0002)
|
|
|
|
typedef struct mps_diag_read_buffer
|
|
{
|
|
uint8_t Status;
|
|
uint8_t Reserved;
|
|
uint16_t Flags;
|
|
uint32_t StartingOffset;
|
|
uint32_t BytesToRead;
|
|
uint32_t UniqueId;
|
|
uint64_t PtrDataBuffer;
|
|
} mps_diag_read_buffer_t;
|
|
|
|
/*
|
|
* Register Access
|
|
*/
|
|
#define REG_IO_READ 1
|
|
#define REG_IO_WRITE 2
|
|
#define REG_MEM_READ 3
|
|
#define REG_MEM_WRITE 4
|
|
|
|
typedef struct mps_reg_access
|
|
{
|
|
uint32_t Command;
|
|
uint32_t RegOffset;
|
|
uint32_t RegData;
|
|
} mps_reg_access_t;
|
|
|
|
typedef struct mps_btdh_mapping
|
|
{
|
|
uint16_t TargetID;
|
|
uint16_t Bus;
|
|
uint16_t DevHandle;
|
|
uint16_t Reserved;
|
|
} mps_btdh_mapping_t;
|
|
|
|
#define MPSIO_MPS_COMMAND_FLAG_VERBOSE 0x01
|
|
#define MPSIO_MPS_COMMAND_FLAG_DEBUG 0x02
|
|
#define MPSIO_READ_CFG_HEADER _IOWR('M', 200, struct mps_cfg_page_req)
|
|
#define MPSIO_READ_CFG_PAGE _IOWR('M', 201, struct mps_cfg_page_req)
|
|
#define MPSIO_READ_EXT_CFG_HEADER _IOWR('M', 202, struct mps_ext_cfg_page_req)
|
|
#define MPSIO_READ_EXT_CFG_PAGE _IOWR('M', 203, struct mps_ext_cfg_page_req)
|
|
#define MPSIO_WRITE_CFG_PAGE _IOWR('M', 204, struct mps_cfg_page_req)
|
|
#define MPSIO_RAID_ACTION _IOWR('M', 205, struct mps_raid_action)
|
|
#define MPSIO_MPS_COMMAND _IOWR('M', 210, struct mps_usr_command)
|
|
|
|
#define MPTIOCTL ('I')
|
|
#define MPTIOCTL_GET_ADAPTER_DATA _IOWR(MPTIOCTL, 1,\
|
|
struct mps_adapter_data)
|
|
#define MPTIOCTL_UPDATE_FLASH _IOWR(MPTIOCTL, 2,\
|
|
struct mps_update_flash)
|
|
#define MPTIOCTL_RESET_ADAPTER _IO(MPTIOCTL, 3)
|
|
#define MPTIOCTL_PASS_THRU _IOWR(MPTIOCTL, 4,\
|
|
struct mps_pass_thru)
|
|
#define MPTIOCTL_EVENT_QUERY _IOWR(MPTIOCTL, 5,\
|
|
struct mps_event_query)
|
|
#define MPTIOCTL_EVENT_ENABLE _IOWR(MPTIOCTL, 6,\
|
|
struct mps_event_enable)
|
|
#define MPTIOCTL_EVENT_REPORT _IOWR(MPTIOCTL, 7,\
|
|
struct mps_event_report)
|
|
#define MPTIOCTL_GET_PCI_INFO _IOWR(MPTIOCTL, 8,\
|
|
struct mps_pci_info)
|
|
#define MPTIOCTL_DIAG_ACTION _IOWR(MPTIOCTL, 9,\
|
|
struct mps_diag_action)
|
|
#define MPTIOCTL_REG_ACCESS _IOWR(MPTIOCTL, 10,\
|
|
struct mps_reg_access)
|
|
#define MPTIOCTL_BTDH_MAPPING _IOWR(MPTIOCTL, 11,\
|
|
struct mps_btdh_mapping)
|
|
|
|
#endif /* !_MPS_IOCTL_H_ */
|