Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 41e2b905 authored by Maciej Trela's avatar Maciej Trela Committed by Dan Williams
Browse files

isci: remove base_port abstraction



Merge struct sci_base_port into scic_sds_port.  Until now sci_base_port
was referenced indirectly with scic_sds_port->parent field.

'sci_base_port' state machine handlers were also incorporated into
scic_sds_port handlers.

Reported-by: default avatarChristoph Hellwig <hch@lst.de>
Signed-off-by: default avatarMaciej Trela <Maciej.Trela@intel.com>
Signed-off-by: default avatarMaciej Patelczyk <maciej.patelczyk@intel.com>
Signed-off-by: default avatarDan Williams <dan.j.williams@intel.com>
parent 0ea99d52
Loading
Loading
Loading
Loading
+0 −187
Original line number Diff line number Diff line
/*
 * 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_BASE_PORT_H_
#define _SCI_BASE_PORT_H_

#include "sci_base_state_machine.h"
#include "sci_object.h"

/**
 * enum sci_base_port_states - This enumeration depicts all the states for the
 *    common port state machine.
 *
 *
 */
enum sci_base_port_states {
	/**
	 * This state indicates that the port has successfully been stopped.
	 * In this state no new IO operations are permitted.
	 * This state is entered from the STOPPING state.
	 */
	SCI_BASE_PORT_STATE_STOPPED,

	/**
	 * This state indicates that the port is in the process of stopping.
	 * In this state no new IO operations are permitted, but existing IO
	 * operations are allowed to complete.
	 * This state is entered from the READY state.
	 */
	SCI_BASE_PORT_STATE_STOPPING,

	/**
	 * This state indicates the port is now ready.  Thus, the user is
	 * able to perform IO operations on this port.
	 * This state is entered from the STARTING state.
	 */
	SCI_BASE_PORT_STATE_READY,

	/**
	 * This state indicates the port is in the process of performing a hard
	 * reset.  Thus, the user is unable to perform IO operations on this
	 * port.
	 * This state is entered from the READY state.
	 */
	SCI_BASE_PORT_STATE_RESETTING,

	/**
	 * This state indicates the port has failed a reset request.  This state
	 * is entered when a port reset request times out.
	 * This state is entered from the RESETTING state.
	 */
	SCI_BASE_PORT_STATE_FAILED,

	SCI_BASE_PORT_MAX_STATES

};

/**
 * struct sci_base_port - The base port object abstracts the fields common to
 *    all SCI port objects.
 *
 *
 */
struct sci_base_port {
	/**
	 * The field specifies that the parent object for the base controller
	 * is the base object itself.
	 */
	struct sci_base_object parent;

	/**
	 * This field contains the information for the base port state machine.
	 */
	struct sci_base_state_machine state_machine;
};

struct sci_base_phy;

typedef enum sci_status (*sci_base_port_handler_t) (
	struct sci_base_port *);

typedef enum sci_status (*sci_base_port_phy_handler_t) (
	struct sci_base_port *,
	struct sci_base_phy *);

typedef enum sci_status (*sci_base_port_reset_handler_t) (
	struct sci_base_port *,
	u32 timeout);

/**
 * struct sci_base_port_state_handler - This structure contains all of the
 *    state handler methods common to base port state machines.  Handler
 *    methods provide the ability to change the behavior for user requests or
 *    transitions depending on the state the machine is in.
 *
 *
 */
struct sci_base_port_state_handler {
	/**
	 * The start_handler specifies the method invoked when a user
	 * attempts to start a port.
	 */
	sci_base_port_handler_t start_handler;

	/**
	 * The stop_handler specifies the method invoked when a user
	 * attempts to stop a port.
	 */
	sci_base_port_handler_t stop_handler;

	/**
	 * The destruct_handler specifies the method invoked when attempting to
	 * destruct a port.
	 */
	sci_base_port_handler_t destruct_handler;

	/**
	 * The reset_handler specifies the method invoked when a user
	 * attempts to hard reset a port.
	 */
	sci_base_port_reset_handler_t reset_handler;

	/**
	 * The add_phy_handler specifies the method invoked when a user
	 * attempts to add another phy into the port.
	 */
	sci_base_port_phy_handler_t add_phy_handler;

	/**
	 * The remove_phy_handler specifies the method invoked when a user
	 * attempts to remove a phy from the port.
	 */
	sci_base_port_phy_handler_t remove_phy_handler;
};
#endif /* _SCI_BASE_PORT_H_ */
+5 −5
Original line number Diff line number Diff line
@@ -616,10 +616,10 @@ static enum sci_status scic_sds_controller_stop_ports(struct scic_sds_controller

	for (index = 0; index < scic->logical_port_entries; index++) {
		struct scic_sds_port *sci_port = &scic->port_table[index];
		sci_base_port_handler_t stop;
		scic_sds_port_handler_t stop;

		stop = sci_port->state_handlers->parent.stop_handler;
		port_status = stop(&sci_port->parent);
		stop = sci_port->state_handlers->stop_handler;
		port_status = stop(sci_port);

		if ((port_status != SCI_SUCCESS) &&
		    (port_status != SCI_FAILURE_INVALID_STATE)) {
@@ -2860,8 +2860,8 @@ enum sci_status scic_controller_start(struct scic_sds_controller *scic,
	for (index = 0; index < scic->logical_port_entries; index++) {
		struct scic_sds_port *sci_port = &scic->port_table[index];

		result = sci_port->state_handlers->parent.start_handler(
				&sci_port->parent);
		result = sci_port->state_handlers->start_handler(
				sci_port);
		if (result)
			return result;
	}
+172 −270

File changed.

Preview size limit exceeded, changes collapsed.

+107 −61
Original line number Diff line number Diff line
@@ -56,22 +56,19 @@
#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 <linux/kernel.h>
#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

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

/**
 * This constant defines the value utilized by SCI Components to indicate
 * an invalid handle.
@@ -107,10 +104,53 @@ enum scic_sds_port_ready_substates {
	SCIC_SDS_PORT_READY_MAX_SUBSTATES
};

struct scic_sds_controller;
struct scic_sds_phy;
struct scic_sds_remote_device;
struct scic_sds_request;
/**
 * enum scic_sds_port_states - This enumeration depicts all the states for the
 *    common port state machine.
 *
 *
 */
enum scic_sds_port_states {
	/**
	 * This state indicates that the port has successfully been stopped.
	 * In this state no new IO operations are permitted.
	 * This state is entered from the STOPPING state.
	 */
	SCI_BASE_PORT_STATE_STOPPED,

	/**
	 * This state indicates that the port is in the process of stopping.
	 * In this state no new IO operations are permitted, but existing IO
	 * operations are allowed to complete.
	 * This state is entered from the READY state.
	 */
	SCI_BASE_PORT_STATE_STOPPING,

	/**
	 * This state indicates the port is now ready.  Thus, the user is
	 * able to perform IO operations on this port.
	 * This state is entered from the STARTING state.
	 */
	SCI_BASE_PORT_STATE_READY,

	/**
	 * This state indicates the port is in the process of performing a hard
	 * reset.  Thus, the user is unable to perform IO operations on this
	 * port.
	 * This state is entered from the READY state.
	 */
	SCI_BASE_PORT_STATE_RESETTING,

	/**
	 * This state indicates the port has failed a reset request.  This state
	 * is entered when a port reset request times out.
	 * This state is entered from the RESETTING state.
	 */
	SCI_BASE_PORT_STATE_FAILED,

	SCI_BASE_PORT_MAX_STATES

};

/**
 * struct scic_sds_port -
@@ -119,9 +159,15 @@ struct scic_sds_request;
 */
struct scic_sds_port {
	/**
	 * This field is the oommon base port object.
	 * The field specifies that the parent object for the base controller
	 * is the base object itself.
	 */
	struct sci_base_port parent;
	struct sci_base_object parent;

	/**
	 * This field contains the information for the base port state machine.
	 */
	struct sci_base_state_machine state_machine;

	/**
	 * This field is the port index that is reported to the SCI USER.
@@ -214,6 +260,15 @@ struct scic_sds_port {

};

struct sci_base_phy;

typedef enum sci_status (*scic_sds_port_handler_t)(struct scic_sds_port *);

typedef enum sci_status (*scic_sds_port_phy_handler_t)(struct scic_sds_port *,
						       struct sci_base_phy *);

typedef enum sci_status (*scic_sds_port_reset_handler_t)(struct scic_sds_port *,
							 u32 timeout);

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

@@ -221,13 +276,46 @@ typedef enum sci_status (*scic_sds_port_frame_handler_t)(struct scic_sds_port *,

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 *,
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;
	/**
	 * The start_handler specifies the method invoked when a user
	 * attempts to start a port.
	 */
	scic_sds_port_handler_t start_handler;

	/**
	 * The stop_handler specifies the method invoked when a user
	 * attempts to stop a port.
	 */
	scic_sds_port_handler_t stop_handler;

	/**
	 * The destruct_handler specifies the method invoked when attempting to
	 * destruct a port.
	 */
	scic_sds_port_handler_t destruct_handler;

	/**
	 * The reset_handler specifies the method invoked when a user
	 * attempts to hard reset a port.
	 */
	scic_sds_port_reset_handler_t reset_handler;

	/**
	 * The add_phy_handler specifies the method invoked when a user
	 * attempts to add another phy into the port.
	 */
	scic_sds_port_phy_handler_t add_phy_handler;

	/**
	 * The remove_phy_handler specifies the method invoked when a user
	 * attempts to remove a phy from the port.
	 */
	scic_sds_port_phy_handler_t remove_phy_handler;

	scic_sds_port_frame_handler_t frame_handler;
	scic_sds_port_event_handler_t event_handler;
@@ -292,15 +380,6 @@ static inline void scic_sds_port_decrement_request_count(struct scic_sds_port *s
#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,
@@ -312,8 +391,6 @@ enum sci_status scic_sds_port_initialize(
	void __iomem *port_configuration_regsiter,
	void __iomem *viit_registers);

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

enum sci_status scic_sds_port_add_phy(
	struct scic_sds_port *this_port,
	struct scic_sds_phy *the_phy);
@@ -332,9 +409,6 @@ void scic_sds_port_deactivate_phy(
	struct scic_sds_phy *phy,
	bool do_notify_user);




bool scic_sds_port_link_detected(
	struct scic_sds_port *this_port,
	struct scic_sds_phy *phy);
@@ -347,11 +421,6 @@ 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,
@@ -362,23 +431,6 @@ enum sci_status scic_sds_port_complete_io(
	struct scic_sds_remote_device *the_device,
	struct scic_sds_request *the_io_request);

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


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













enum sci_sas_link_rate scic_sds_port_get_max_allowed_speed(
	struct scic_sds_port *this_port);

@@ -390,8 +442,6 @@ bool scic_sds_port_is_valid_phy_assignment(
	struct scic_sds_port *this_port,
	u32 phy_index);



void scic_sds_port_get_sas_address(
	struct scic_sds_port *this_port,
	struct sci_sas_address *sas_address);
@@ -404,8 +454,4 @@ void scic_sds_port_get_attached_protocols(
	struct scic_sds_port *this_port,
	struct sci_sas_identify_address_frame_protocols *protocols);





#endif /* _SCIC_SDS_PORT_H_ */
+1 −1
Original line number Diff line number Diff line
@@ -700,7 +700,7 @@ static void scic_sds_apc_agent_link_up(struct scic_sds_controller *scic,
		scic_sds_apc_agent_configure_ports(scic, port_agent, sci_phy, true);
	} else {
		/* the phy is already the part of the port */
		u32 port_state = sci_port->parent.state_machine.current_state_id;
		u32 port_state = sci_port->state_machine.current_state_id;

		/* if the PORT'S state is resetting then the link up is from
		 * port hard reset in this case, we need to tell the port