mpt2sas_ctl.h

Go to the documentation of this file.

/*
 * Management Module Support for MPT (Message Passing Technology) based
 * controllers
 *
 * This code is based on drivers/scsi/mpt2sas/mpt2_ctl.h
 * Copyright (C) 2007-2012  LSI Corporation
 *  (mailto:[email protected])
 *
 * 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.
 *
 * NO WARRANTY
 * THE PROGRAM IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR
 * CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT
 * LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT,
 * MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Each Recipient is
 * solely responsible for determining the appropriateness of using and
 * distributing the Program and assumes all risks associated with its
 * exercise of rights under this Agreement, including but not limited to
 * the risks and costs of program errors, damage to or loss of data,
 * programs or equipment, and unavailability or interruption of operations.

 * DISCLAIMER OF LIABILITY
 * NEITHER RECIPIENT NOR ANY CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING WITHOUT LIMITATION LOST PROFITS), 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 OR DISTRIBUTION OF THE PROGRAM OR THE EXERCISE OF ANY RIGHTS GRANTED
 * HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES

 * 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., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301,
 * USA.
 */

#ifndef MPT2SAS_CTL_H_INCLUDED
#define MPT2SAS_CTL_H_INCLUDED

#ifdef __KERNEL__
#include <linux/miscdevice.h>
#endif

#define MPT2SAS_DEV_NAME    "mpt2ctl"
#define MPT2_MAGIC_NUMBER   'L'
#define MPT2_IOCTL_DEFAULT_TIMEOUT (10) /* in seconds */

#define MPT2IOCINFO _IOWR(MPT2_MAGIC_NUMBER, 17, \
    struct mpt2_ioctl_iocinfo)
#define MPT2COMMAND _IOWR(MPT2_MAGIC_NUMBER, 20, \
    struct mpt2_ioctl_command)
#ifdef CONFIG_COMPAT
#define MPT2COMMAND32   _IOWR(MPT2_MAGIC_NUMBER, 20, \
    struct mpt2_ioctl_command32)
#endif
#define MPT2EVENTQUERY  _IOWR(MPT2_MAGIC_NUMBER, 21, \
    struct mpt2_ioctl_eventquery)
#define MPT2EVENTENABLE _IOWR(MPT2_MAGIC_NUMBER, 22, \
    struct mpt2_ioctl_eventenable)
#define MPT2EVENTREPORT _IOWR(MPT2_MAGIC_NUMBER, 23, \
    struct mpt2_ioctl_eventreport)
#define MPT2HARDRESET   _IOWR(MPT2_MAGIC_NUMBER, 24, \
    struct mpt2_ioctl_diag_reset)
#define MPT2BTDHMAPPING _IOWR(MPT2_MAGIC_NUMBER, 31, \
    struct mpt2_ioctl_btdh_mapping)

/* diag buffer support */
#define MPT2DIAGREGISTER _IOWR(MPT2_MAGIC_NUMBER, 26, \
    struct mpt2_diag_register)
#define MPT2DIAGRELEASE _IOWR(MPT2_MAGIC_NUMBER, 27, \
    struct mpt2_diag_release)
#define MPT2DIAGUNREGISTER _IOWR(MPT2_MAGIC_NUMBER, 28, \
    struct mpt2_diag_unregister)
#define MPT2DIAGQUERY   _IOWR(MPT2_MAGIC_NUMBER, 29, \
    struct mpt2_diag_query)
#define MPT2DIAGREADBUFFER _IOWR(MPT2_MAGIC_NUMBER, 30, \
    struct mpt2_diag_read_buffer)

struct mpt2_ioctl_header {
    uint32_t ioc_number;
    uint32_t port_number;
    uint32_t max_data_size;
};

struct mpt2_ioctl_diag_reset {
    struct mpt2_ioctl_header hdr;
};


struct mpt2_ioctl_pci_info {
    union {
        struct {
            uint32_t device:5;
            uint32_t function:3;
            uint32_t bus:24;
        } bits;
        uint32_t  word;
    } u;
    uint32_t segment_id;
};


#define MPT2_IOCTL_INTERFACE_SCSI   (0x00)
#define MPT2_IOCTL_INTERFACE_FC     (0x01)
#define MPT2_IOCTL_INTERFACE_FC_IP  (0x02)
#define MPT2_IOCTL_INTERFACE_SAS    (0x03)
#define MPT2_IOCTL_INTERFACE_SAS2   (0x04)
#define MPT2_IOCTL_INTERFACE_SAS2_SSS6200   (0x05)
#define MPT2_IOCTL_VERSION_LENGTH   (32)

struct mpt2_ioctl_iocinfo {
    struct mpt2_ioctl_header hdr;
    uint32_t adapter_type;
    uint32_t port_number;
    uint32_t pci_id;
    uint32_t hw_rev;
    uint32_t subsystem_device;
    uint32_t subsystem_vendor;
    uint32_t rsvd0;
    uint32_t firmware_version;
    uint32_t bios_version;
    uint8_t driver_version[MPT2_IOCTL_VERSION_LENGTH];
    uint8_t rsvd1;
    uint8_t scsi_id;
    uint16_t rsvd2;
    struct mpt2_ioctl_pci_info pci_information;
};


/* number of event log entries */
#define MPT2SAS_CTL_EVENT_LOG_SIZE (50)

struct mpt2_ioctl_eventquery {
    struct mpt2_ioctl_header hdr;
    uint16_t event_entries;
    uint16_t rsvd;
    uint32_t event_types[MPI2_EVENT_NOTIFY_EVENTMASK_WORDS];
};

struct mpt2_ioctl_eventenable {
    struct mpt2_ioctl_header hdr;
    uint32_t event_types[4];
};

#define MPT2_EVENT_DATA_SIZE (192)

struct MPT2_IOCTL_EVENTS {
    uint32_t event;
    uint32_t context;
    uint8_t data[MPT2_EVENT_DATA_SIZE];
};

struct mpt2_ioctl_eventreport {
    struct mpt2_ioctl_header hdr;
    struct MPT2_IOCTL_EVENTS event_data[1];
};

struct mpt2_ioctl_command {
    struct mpt2_ioctl_header hdr;
    uint32_t timeout;
    void __user *reply_frame_buf_ptr;
    void __user *data_in_buf_ptr;
    void __user *data_out_buf_ptr;
    void __user *sense_data_ptr;
    uint32_t max_reply_bytes;
    uint32_t data_in_size;
    uint32_t data_out_size;
    uint32_t max_sense_bytes;
    uint32_t data_sge_offset;
    uint8_t mf[1];
};

#ifdef CONFIG_COMPAT
struct mpt2_ioctl_command32 {
    struct mpt2_ioctl_header hdr;
    uint32_t timeout;
    uint32_t reply_frame_buf_ptr;
    uint32_t data_in_buf_ptr;
    uint32_t data_out_buf_ptr;
    uint32_t sense_data_ptr;
    uint32_t max_reply_bytes;
    uint32_t data_in_size;
    uint32_t data_out_size;
    uint32_t max_sense_bytes;
    uint32_t data_sge_offset;
    uint8_t mf[1];
};
#endif

struct mpt2_ioctl_btdh_mapping {
    struct mpt2_ioctl_header hdr;
    uint32_t id;
    uint32_t bus;
    uint16_t handle;
    uint16_t rsvd;
};


/* status bits for ioc->diag_buffer_status */
#define MPT2_DIAG_BUFFER_IS_REGISTERED  (0x01)
#define MPT2_DIAG_BUFFER_IS_RELEASED    (0x02)
#define MPT2_DIAG_BUFFER_IS_DIAG_RESET  (0x04)

/* application flags for mpt2_diag_register, mpt2_diag_query */
#define MPT2_APP_FLAGS_APP_OWNED    (0x0001)
#define MPT2_APP_FLAGS_BUFFER_VALID (0x0002)
#define MPT2_APP_FLAGS_FW_BUFFER_ACCESS (0x0004)

/* flags for mpt2_diag_read_buffer */
#define MPT2_FLAGS_REREGISTER       (0x0001)

#define MPT2_PRODUCT_SPECIFIC_DWORDS        23

struct mpt2_diag_register {
    struct mpt2_ioctl_header hdr;
    uint8_t reserved;
    uint8_t buffer_type;
    uint16_t application_flags;
    uint32_t diagnostic_flags;
    uint32_t product_specific[MPT2_PRODUCT_SPECIFIC_DWORDS];
    uint32_t requested_buffer_size;
    uint32_t unique_id;
};

struct mpt2_diag_unregister {
    struct mpt2_ioctl_header hdr;
    uint32_t unique_id;
};

struct mpt2_diag_query {
    struct mpt2_ioctl_header hdr;
    uint8_t reserved;
    uint8_t buffer_type;
    uint16_t application_flags;
    uint32_t diagnostic_flags;
    uint32_t product_specific[MPT2_PRODUCT_SPECIFIC_DWORDS];
    uint32_t total_buffer_size;
    uint32_t driver_added_buffer_size;
    uint32_t unique_id;
};

struct mpt2_diag_release {
    struct mpt2_ioctl_header hdr;
    uint32_t unique_id;
};

struct mpt2_diag_read_buffer {
    struct mpt2_ioctl_header hdr;
    uint8_t status;
    uint8_t reserved;
    uint16_t flags;
    uint32_t starting_offset;
    uint32_t bytes_to_read;
    uint32_t unique_id;
    uint32_t diagnostic_data[1];
};

#endif /* MPT2SAS_CTL_H_INCLUDED */