9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * CDDL HEADER START
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * The contents of this file are subject to the terms of the
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * Common Development and Distribution License (the "License").
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * You may not use this file except in compliance with the License.
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * See the License for the specific language governing permissions
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * and limitations under the License.
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * When distributing Covered Code, include this CDDL HEADER in each
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * If applicable, add the following below this CDDL HEADER, with the
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * fields enclosed by brackets "[]" replaced with your own identifying
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * information: Portions Copyright [yyyy] [name of copyright owner]
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * CDDL HEADER END
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * Copyright 2008 Sun Microsystems, Inc. All rights reserved.
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * Use is subject to license terms.
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * Contains all of the prototypes, #defines, and structures necessary
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * for all ioctl access into the driver. This includes everything
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * necessary for updating firmware, accessing the hermon flash device,
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * providing interfaces for VTS.
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylorint hermon_ioctl(dev_t dev, int cmd, intptr_t arg, int mode, cred_t *credp,
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * Enumerated type for the Hermon ioctl() interface types
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * originally, to make a unique set of IOCTLs but now share the actual
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * value w/ tavor & arbel (memfree) to make VTS consistent & simpler
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * #define HERMON_IOCTL ('h' << 8)
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylortypedef enum {
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor HERMON_IOCTL_WRITE_BOOT_ADDR = HERMON_IOCTL | 0x24
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylortypedef enum {
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor HERMON_IOCTL_WRITE_BOOT_ADDR = HERMON_IOCTL | 0x24
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor#endif /* DEBUG */
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * Specific operations for each of the flash ioctl interfaces
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * Default values for the flash (overridden by CFI info, if available)
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * CFI (Common Flash Interface) initialization
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor/* For compatability */
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor#define HERMON_FLASH_CFI_SIZE_QUADLET HERMON_FLASH_CFI_SIZE >> 2
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * Expand CFI data size to support the Intel Expanded Command Set.
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor#define HERMON_CFI_INFO_QSIZE HERMON_CFI_INFO_SIZE >> 2
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * Mellanox uses two different parallel Flash devices for Hermon
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * HCAs: the AMD AM29LV033C and the Intel 28F320J3C. The AM29LV033C
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * utilizes the AMD Standard CFI command set while the 28F320J3C
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * utliizes the Intel Extended CFI command set. Additionally, serial
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * SPI flash is supported, such as the STMicroelectronics M25Pxx family
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * of SPI Flash parts.
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * The firmware version structure used in HERMON_IOCTL_INFO and
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * HERMON_IOCTL_FLASH_INIT interfaces. The structure consists of major,
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * minor and subminor portions for firmware revision number.
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * structure used for read, write, and erase flash routines
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * Supported fields for each type:
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * read_sector: af_type, af_sector, af_sector_num
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * read_quadlet: af_type, af_addr, af_quadlet
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * write_sector: af_type, af_sector, af_sector_num
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * write_byte: af_type, af_addr, af_byte
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * erase_sector: af_type, af_sector_num
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * erase_chip: af_type
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * The 'tf_sector' field must point to a sector sized portion of memory, as
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * all sector read/write ioctl calls are done as one complete sector only.
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor/* Structure used for flash init interface */
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor uint32_t af_cfi_info[HERMON_FLASH_CFI_SIZE_QUADLET];
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * The structure used for Hermon register read/write interface.
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * The "trg_reg_set" field indicates the register set (the BAR) from which
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * the access is desired (HERMON_CMD_BAR, HERMON_UAR_BAR, or HERMON_DDR_BAR).
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * The "trg_offset" and "trg_data" fields indicate the register and either
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * the destination or source of the data to be read/written.
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * Hermon VTS IOCTL revision number. This revision number is currently
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * expected to be passed in all Hermon VTS ioctl interfaces.
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * The port structure used in HERMON_IOCTL_PORTS interface.
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * Each port has an associated guid, port number, and IBA-defined
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * logical port state.
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * The structure used for the HERMON_IOCTL_PORTS interface.
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * The number of ports and a buffer large enough for 256
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * port structures will be supplied by the caller. The
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * revision should be set to HERMON_VTS_IOCTL_REVISION. The
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * number of ports ("tp_num_ports") is always returned,
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * regardless of success or failure otherwise.
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * These are the status codes that can be returned by the
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * HERMON_IOCTL_LOOPBACK test. They are returned as part of
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * the hermon_loopback_ioctl_t struct (below).
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylortypedef enum {
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * The structure used for HERMON_IOCTL_LOOPBACK interface.
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * It defines the port number, number of iterations, wait duration,
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * number of retries and the data pattern to be sent. Upon return,
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * the driver will supply the number of iterations succesfully
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * completed, and the kind of failure (if any, along with the failing
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * data pattern).
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * The structure used for the HERMON_IOCTL_INFO interface. It
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * includes firmware version, hardware version, accessable
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor * range of adapter DDR memory, and adapter flash memory size.
9e39c5ba00a55fa05777cc94b148296af305e135Bill Taylor#endif /* _SYS_IB_ADAPTERS_HERMON_IOCTL_H */