path: root/drivers/scsi/isci/core/scic_sds_port.h

/*
 * 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 _SCIC_SDS_PORT_H_
#define _SCIC_SDS_PORT_H_

/**
 * This file contains the structures, constants and prototypes for the
 *    struct scic_sds_port object.
 *
 *
 */

#include "sci_controller_constants.h"
#include "intel_sas.h"
#include "sci_base_port.h"
#include "sci_base_phy.h"
#include "scu_registers.h"

#define SCIC_SDS_DUMMY_PORT   0xFF

/**
 * enum SCIC_SDS_PORT_READY_SUBSTATES -
 *
 * This enumeration depicts all of the states for the core port ready substate
 * machine.
 */
enum SCIC_SDS_PORT_READY_SUBSTATES {
	/**
	 * The substate where the port is started and ready but has no active phys.
	 */
	SCIC_SDS_PORT_READY_SUBSTATE_WAITING,

	/**
	 * The substate where the port is started and ready and there is at least one
	 * phy operational.
	 */
	SCIC_SDS_PORT_READY_SUBSTATE_OPERATIONAL,

	/**
	 * The substate where the port is started and there was an add/remove phy
	 * event.  This state is only used in Automatic Port Configuration Mode (APC)
	 */
	SCIC_SDS_PORT_READY_SUBSTATE_CONFIGURING,

	SCIC_SDS_PORT_READY_MAX_SUBSTATES
};

struct scic_sds_controller;
struct scic_sds_phy;
struct scic_sds_remote_device;
struct scic_sds_request;

/**
 * struct scic_sds_port -
 *
 * The core port object provides the the abstraction for an SCU port.
 */
struct scic_sds_port {
	/**
	 * This field is the oommon base port object.
	 */
	struct sci_base_port parent;

	/**
	 * This field is the port index that is reported to the SCI USER.  This allows
	 * the actual hardware physical port to change without the SCI USER getting a
	 * different answer for the get port index.
	 */
	u8 logical_port_index;

	/**
	 * This field is the port index used to program the SCU hardware.
	 */
	u8 physical_port_index;

	/**
	 * This field contains the active phy mask for the port.  This mask is used in
	 * conjunction with the phy state to determine which phy to select for some
	 * port operations.
	 */
	u8 active_phy_mask;

	/**
	 * This field contains the count of the io requests started on this port
	 * object.  It is used to control controller shutdown.
	 */
	u32 started_request_count;

	/**
	 * This field contains the number of devices assigned to this port.  It is
	 * used to control port start requests.
	 */
	u32 assigned_device_count;

	/**
	 * This field contains the reason for the port not going ready.  It is
	 * assigned in the state handlers and used in the state transition.
	 */
	u32 not_ready_reason;

	/**
	 * This field is the table of phys assigned to the port.
	 */
	struct scic_sds_phy *phy_table[SCI_MAX_PHYS];

	/**
	 * This field is a pointer back to the controller that owns this port object.
	 */
	struct scic_sds_controller *owning_controller;

	/**
	 * This field contains the port start/stop timer handle.
	 */
	void *timer_handle;

	/**
	 * This field points to the current set of state handlers for this port
	 * object.  These state handlers are assigned at each enter state of the state
	 * machine.
	 */
	struct scic_sds_port_state_handler *state_handlers;

	/**
	 * This field is the ready substate machine for the port.
	 */
	struct sci_base_state_machine ready_substate_machine;

	/* / Memory mapped hardware register space */
	/**
	 * This field is the pointer to the transport layer register for the SCU
	 * hardware.
	 */
	struct scu_transport_layer_registers *transport_layer_registers;

	/**
	 * This field is the pointer to the port task scheduler registers for the SCU
	 * hardware.
	 */
	struct scu_port_task_scheduler_registers *port_task_scheduler_registers;

	/**
	 * This field is identical for all port objects and points to the port task
	 * scheduler group PE configuration registers.  It is used to assign PEs to a
	 * port.
	 */
	SCU_PORT_PE_CONFIGURATION_REGISTER_T *port_pe_configuration_register;

	/**
	 * This field is the VIIT register space for ths port object.
	 */
	struct scu_viit_entry *viit_registers;

};


typedef enum sci_status (*SCIC_SDS_PORT_EVENT_HANDLER_T)(struct scic_sds_port *, u32);

typedef enum sci_status (*SCIC_SDS_PORT_FRAME_HANDLER_T)(struct scic_sds_port *, u32);

typedef void (*SCIC_SDS_PORT_LINK_HANDLER_T)(struct scic_sds_port *, struct scic_sds_phy *);

typedef enum sci_status (*SCIC_SDS_PORT_IO_REQUEST_HANDLER_T)(
	struct scic_sds_port *,
	struct scic_sds_remote_device *,
	struct scic_sds_request *);

struct scic_sds_port_state_handler {
	struct sci_base_port_state_handler parent;

	SCIC_SDS_PORT_FRAME_HANDLER_T frame_handler;
	SCIC_SDS_PORT_EVENT_HANDLER_T event_handler;

	SCIC_SDS_PORT_LINK_HANDLER_T link_up_handler;
	SCIC_SDS_PORT_LINK_HANDLER_T link_down_handler;

	SCIC_SDS_PORT_IO_REQUEST_HANDLER_T start_io_handler;
	SCIC_SDS_PORT_IO_REQUEST_HANDLER_T complete_io_handler;

};

extern const struct sci_base_state scic_sds_port_state_table[];
extern const struct sci_base_state scic_sds_port_ready_substate_table[];

extern struct scic_sds_port_state_handler scic_sds_port_state_handler_table[];
extern struct scic_sds_port_state_handler scic_sds_port_ready_substate_handler_table[];

/**
 * scic_sds_port_get_controller() -
 *
 * Helper macro to get the owning controller of this port
 */
#define scic_sds_port_get_controller(this_port)	\
	((this_port)->owning_controller)

/**
 * scic_sds_port_get_base_state_machine() -
 *
 * Helper macro to get the base state machine for this port
 */
#define scic_sds_port_get_base_state_machine(this_port)	\
	(&(this_port)->parent.state_machine)

/**
 * scic_sds_port_set_base_state_handlers() -
 *
 * This macro will change the state handlers to those of the specified state id
 */
#define scic_sds_port_set_base_state_handlers(this_port, state_id) \
	scic_sds_port_set_state_handlers(\
		(this_port), &scic_sds_port_state_handler_table[(state_id)])

/**
 * scic_sds_port_get_ready_substate_machine() -
 *
 * Helper macro to get the ready substate machine for this port
 */
#define scic_sds_port_get_ready_substate_machine(this_port) \
	(&(this_port)->ready_substate_machine)

/**
 * scic_sds_port_set_state_handlers() -
 *
 * Helper macro to set the port object state handlers
 */
#define scic_sds_port_set_state_handlers(this_port, handlers) \
	((this_port)->state_handlers = (handlers))

/**
 * scic_sds_port_get_index() -
 *
 * This macro returns the physical port index for this port object
 */
#define scic_sds_port_get_index(this_port) \
	((this_port)->physical_port_index)

/**
 * scic_sds_port_increment_request_count() -
 *
 * Helper macro to increment the started request count
 */
#define scic_sds_port_increment_request_count(this_port) \
	((this_port)->started_request_count++)

#ifdef SCIC_DEBUG_ENABLED
/**
 * scic_sds_port_decrement_request_count() - This method decrements the started
 *    io request count.  The method will not decrment the started io request
 *    count below 0 and will log a debug message if this is attempted.
 *
 *
 */
void scic_sds_port_decrement_request_count(
	struct scic_sds_port *this_port);
#else
/**
 * scic_sds_port_decrement_request_count() -
 *
 * Helper macro to decrement the started io request count.  The macro will not
 * decrement the started io request count below 0.
 */
#define scic_sds_port_decrement_request_count(this_port) \
	(\
		(this_port)->started_request_count = (\
			((this_port)->started_request_count == 0) ? \
			(this_port)->started_request_count : \
			((this_port)->started_request_count - 1) \
			) \
			)
#endif

/**
 * scic_sds_port_write_phy_assignment() -
 *
 * Helper macro to write the phys port assignment
 */
#define scic_sds_port_write_phy_assignment(port, phy) \
	SCU_PCSPExCR_WRITE(\
		(port),	\
		(phy)->phy_index, \
		(port)->physical_port_index \
		)

/**
 * scic_sds_port_read_phy_assignment() -
 *
 * Helper macro to read the phys port assignment
 */
#define scic_sds_port_read_phy_assignment(port, phy) \
	SCU_PCSPExCR_READ(\
		(port),	\
		(phy)->phy_index \
		)

#define scic_sds_port_active_phy(port, phy) \
	(((port)->active_phy_mask & (1 << (phy)->phy_index)) != 0)

/* --------------------------------------------------------------------------- */




/* --------------------------------------------------------------------------- */

/* --------------------------------------------------------------------------- */

void scic_sds_port_construct(
	struct scic_sds_port *this_port,
	u8 port_index,
	struct scic_sds_controller *owning_controller);

enum sci_status scic_sds_port_initialize(
	struct scic_sds_port *this_port,
	void *transport_layer_registers,
	void *port_task_scheduler_registers,
	void *port_configuration_regsiter,
	void *viit_registers);

/* --------------------------------------------------------------------------- */

enum sci_status scic_sds_port_add_phy(
	struct scic_sds_port *this_port,
	struct scic_sds_phy *the_phy);

enum sci_status scic_sds_port_remove_phy(
	struct scic_sds_port *this_port,
	struct scic_sds_phy *the_phy);

void scic_sds_port_set_direct_attached_device_id(
	struct scic_sds_port *this_port,
	u32 device_id);

void scic_sds_port_activate_phy(
	struct scic_sds_port *this_port,
	struct scic_sds_phy *phy,
	bool do_notify_user);

void scic_sds_port_deactivate_phy(
	struct scic_sds_port *this_port,
	struct scic_sds_phy *phy,
	bool do_notify_user);



void scic_sds_port_general_link_up_handler(
	struct scic_sds_port *this_port,
	struct scic_sds_phy *the_phy,
	bool do_notify_user);

bool scic_sds_port_link_detected(
	struct scic_sds_port *this_port,
	struct scic_sds_phy *phy);

void scic_sds_port_link_up(
	struct scic_sds_port *this_port,
	struct scic_sds_phy *phy);

void scic_sds_port_link_down(
	struct scic_sds_port *this_port,
	struct scic_sds_phy *phy);

/* --------------------------------------------------------------------------- */


/* --------------------------------------------------------------------------- */

enum sci_status scic_sds_port_start_io(
	struct scic_sds_port *this_port,
	struct scic_sds_remote_device *the_device,
	struct scic_sds_request *the_io_request);

enum sci_status scic_sds_port_complete_io(
	struct scic_sds_port *this_port,
	struct scic_sds_remote_device *the_device,
	struct scic_sds_request *the_io_request);

/* --------------------------------------------------------------------------- */

void scic_sds_port_update_viit_entry(
	struct scic_sds_port *this_port);

/* --------------------------------------------------------------------------- */

enum sci_status scic_sds_port_default_start_handler(
	struct sci_base_port *port);


enum sci_status scic_sds_port_default_destruct_handler(
	struct sci_base_port *port);

enum sci_status scic_sds_port_default_reset_handler(
	struct sci_base_port *port,
	u32 timeout);


enum sci_status scic_sds_port_default_remove_phy_handler(
	struct sci_base_port *port,
	struct sci_base_phy *phy);

enum sci_status scic_sds_port_default_frame_handler(
	struct scic_sds_port *port,
	u32 frame_index);

enum sci_status scic_sds_port_default_event_handler(
	struct scic_sds_port *port,
	u32 event_code);

void scic_sds_port_default_link_up_handler(
	struct scic_sds_port *this_port,
	struct scic_sds_phy *phy);

void scic_sds_port_default_link_down_handler(
	struct scic_sds_port *this_port,
	struct scic_sds_phy *phy);

enum sci_status scic_sds_port_default_start_io_handler(
	struct scic_sds_port *port,
	struct scic_sds_remote_device *device,
	struct scic_sds_request *io_request);


enum sci_sas_link_rate scic_sds_port_get_max_allowed_speed(
	struct scic_sds_port *this_port);

void scic_sds_port_broadcast_change_received(
	struct scic_sds_port *this_port,
	struct scic_sds_phy *this_phy);

bool scic_sds_port_is_valid_phy_assignment(
	struct scic_sds_port *this_port,
	u32 phy_index);

bool scic_sds_port_is_phy_mask_valid(
	struct scic_sds_port *this_port,
	u32 phy_mask);

u32 scic_sds_port_get_phys(
	struct scic_sds_port *this_port);

void scic_sds_port_get_sas_address(
	struct scic_sds_port *this_port,
	struct sci_sas_address *sas_address);

void scic_sds_port_get_attached_sas_address(
	struct scic_sds_port *this_port,
	struct sci_sas_address *sas_address);

void scic_sds_port_get_attached_protocols(
	struct scic_sds_port *this_port,
	struct sci_sas_identify_address_frame_protocols *protocols);

enum sci_status scic_sds_port_set_phy(
	struct scic_sds_port *port,
	struct scic_sds_phy *phy);

enum sci_status scic_sds_port_clear_phy(
	struct scic_sds_port *port,
	struct scic_sds_phy *phy);



#endif /* _SCIC_SDS_PORT_H_ */