/* * 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) 2008 - 2011 Intel Corporation. All rights reserved. * * 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. * * 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 St - Fifth Floor, Boston, MA 02110-1301 USA. * The full GNU General Public License is included in this distribution * in the file called LICENSE.GPL. * * BSD LICENSE * * Copyright(c) 2008 - 2011 Intel Corporation. All rights reserved. * All rights reserved. * * 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. */ #ifndef _SCI_HOST_H_ #define _SCI_HOST_H_ #include <scsi/sas_ata.h> #include "remote_device.h" #include "phy.h" #include "isci.h" #include "remote_node_table.h" #include "registers.h" #include "unsolicited_frame_control.h" #include "probe_roms.h" struct isci_request; struct scu_task_context; /** * struct sci_power_control - * * This structure defines the fields for managing power control for direct * attached disk devices. */ struct sci_power_control { … }; struct sci_port_configuration_agent; port_config_fn; bool is_port_config_apc(struct isci_host *ihost); bool is_controller_start_complete(struct isci_host *ihost); struct sci_port_configuration_agent { … }; /** * isci_host - primary host/controller object * @timer: timeout start/stop operations * @device_table: rni (hw remote node index) to remote device lookup table * @available_remote_nodes: rni allocator * @power_control: manage device spin up * @io_request_sequence: generation number for tci's (task contexts) * @task_context_table: hw task context table * @remote_node_context_table: hw remote node context table * @completion_queue: hw-producer driver-consumer communication ring * @completion_queue_get: tracks the driver 'head' of the ring to notify hw * @logical_port_entries: min({driver|silicon}-supported-port-count) * @remote_node_entries: min({driver|silicon}-supported-node-count) * @task_context_entries: min({driver|silicon}-supported-task-count) * @phy_timer: phy startup timer * @invalid_phy_mask: if an invalid_link_up notification is reported a bit for * the phy index is set so further notifications are not * made. Once the phy reports link up and is made part of a * port then this bit is cleared. */ struct isci_host { … }; /** * enum sci_controller_states - This enumeration depicts all the states * for the common controller state machine. */ enum sci_controller_states { … }; /** * struct isci_pci_info - This class represents the pci function containing the * controllers. Depending on PCI SKU, there could be up to 2 controllers in * the PCI function. */ #define SCI_MAX_MSIX_INT … struct isci_pci_info { … }; static inline struct isci_pci_info *to_pci_info(struct pci_dev *pdev) { … } static inline struct Scsi_Host *to_shost(struct isci_host *ihost) { … } #define for_each_isci_host(id, ihost, pdev) … static inline void wait_for_start(struct isci_host *ihost) { … } static inline void wait_for_stop(struct isci_host *ihost) { … } static inline void wait_for_device_start(struct isci_host *ihost, struct isci_remote_device *idev) { … } static inline void wait_for_device_stop(struct isci_host *ihost, struct isci_remote_device *idev) { … } static inline struct isci_host *dev_to_ihost(struct domain_device *dev) { … } static inline struct isci_host *idev_to_ihost(struct isci_remote_device *idev) { … } /* we always use protocol engine group zero */ #define ISCI_PEG … /* see sci_controller_io_tag_allocate|free for how seq and tci are built */ #define ISCI_TAG(seq, tci) … /* these are returned by the hardware, so sanitize them */ #define ISCI_TAG_SEQ(tag) … #define ISCI_TAG_TCI(tag) … /* interrupt coalescing baseline: 9 == 3 to 5us interrupt delay per command */ #define ISCI_COALESCE_BASE … /* expander attached sata devices require 3 rnc slots */ static inline int sci_remote_device_node_count(struct isci_remote_device *idev) { … } /** * sci_controller_clear_invalid_phy() - * * This macro will clear the bit in the invalid phy mask for this controller * object. This is used to control messages reported for invalid link up * notifications. */ #define sci_controller_clear_invalid_phy(controller, phy) … static inline struct device *scirdev_to_dev(struct isci_remote_device *idev) { … } static inline bool is_a2(struct pci_dev *pdev) { … } static inline bool is_b0(struct pci_dev *pdev) { … } static inline bool is_c0(struct pci_dev *pdev) { … } static inline bool is_c1(struct pci_dev *pdev) { … } enum cable_selections { … }; #define CABLE_OVERRIDE_DISABLED … static inline int is_cable_select_overridden(void) { … } enum cable_selections decode_cable_selection(struct isci_host *ihost, int phy); void validate_cable_selections(struct isci_host *ihost); char *lookup_cable_names(enum cable_selections); /* set hw control for 'activity', even though active enclosures seem to drive * the activity led on their own. Skip setting FSENG control on 'status' due * to unexpected operation and 'error' due to not being a supported automatic * FSENG output */ #define SGPIO_HW_CONTROL … static inline int isci_gpio_count(struct isci_host *ihost) { … } void sci_controller_post_request(struct isci_host *ihost, u32 request); void sci_controller_release_frame(struct isci_host *ihost, u32 frame_index); void sci_controller_copy_sata_response(void *response_buffer, void *frame_header, void *frame_buffer); enum sci_status sci_controller_allocate_remote_node_context(struct isci_host *ihost, struct isci_remote_device *idev, u16 *node_id); void sci_controller_free_remote_node_context( struct isci_host *ihost, struct isci_remote_device *idev, u16 node_id); struct isci_request *sci_request_by_tag(struct isci_host *ihost, u16 io_tag); void sci_controller_power_control_queue_insert(struct isci_host *ihost, struct isci_phy *iphy); void sci_controller_power_control_queue_remove(struct isci_host *ihost, struct isci_phy *iphy); void sci_controller_link_up(struct isci_host *ihost, struct isci_port *iport, struct isci_phy *iphy); void sci_controller_link_down(struct isci_host *ihost, struct isci_port *iport, struct isci_phy *iphy); void sci_controller_remote_device_stopped(struct isci_host *ihost, struct isci_remote_device *idev); enum sci_status sci_controller_continue_io(struct isci_request *ireq); int isci_host_scan_finished(struct Scsi_Host *, unsigned long); void isci_host_start(struct Scsi_Host *); u16 isci_alloc_tag(struct isci_host *ihost); enum sci_status isci_free_tag(struct isci_host *ihost, u16 io_tag); void isci_tci_free(struct isci_host *ihost, u16 tci); void ireq_done(struct isci_host *ihost, struct isci_request *ireq, struct sas_task *task); int isci_host_init(struct isci_host *); void isci_host_completion_routine(unsigned long data); void isci_host_deinit(struct isci_host *); void sci_controller_disable_interrupts(struct isci_host *ihost); bool sci_controller_has_remote_devices_stopping(struct isci_host *ihost); void sci_controller_transition_to_ready(struct isci_host *ihost, enum sci_status status); enum sci_status sci_controller_start_io( struct isci_host *ihost, struct isci_remote_device *idev, struct isci_request *ireq); enum sci_status sci_controller_start_task( struct isci_host *ihost, struct isci_remote_device *idev, struct isci_request *ireq); enum sci_status sci_controller_terminate_request( struct isci_host *ihost, struct isci_remote_device *idev, struct isci_request *ireq); enum sci_status sci_controller_complete_io( struct isci_host *ihost, struct isci_remote_device *idev, struct isci_request *ireq); void sci_port_configuration_agent_construct( struct sci_port_configuration_agent *port_agent); enum sci_status sci_port_configuration_agent_initialize( struct isci_host *ihost, struct sci_port_configuration_agent *port_agent); int isci_gpio_write(struct sas_ha_struct *, u8 reg_type, u8 reg_index, u8 reg_count, u8 *write_data); #endif
Codebase Browser
linux