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

Commit 068b2c03 authored by Dan Williams's avatar Dan Williams
Browse files

isci: kill some long macros 



Delete some macros that are longer to type than the open coded operation
that they perform.

scic_sds_phy_get_base_state_machine
scic_sds_phy_get_starting_substate_machine
scic_sds_port_get_base_state_machine
scic_sds_port_get_ready_substate_machine
scic_sds_remote_device_get_base_state_machine
scic_sds_remote_device_get_ready_substate_machine
scic_sds_remote_node_context_set_remote_node_index
scic_sds_controller_get_base_state_machine

Also performs some collateral cleanups like killing casts that assume
structure member ordering, and consolidating a lot of duplicated default
handler code (the primary callers of the *_get_base_state_machine macros) via
a helper.

Reported-by: default avatarChristoph Hellwig <hch@infradead.org>
Signed-off-by: default avatarDan Williams <dan.j.williams@intel.com>
parent f942f32e

drivers/scsi/isci/core/scic_sds_controller.c

+60 −199
Original line number Diff line number Diff line
@@ -739,8 +739,7 @@ static void scic_sds_controller_transition_to_ready( 
		 * We move into the ready state, because some of the phys/ports

		 * may be up and operational.

		 */

		sci_base_state_machine_change_state(

			scic_sds_controller_get_base_state_machine(scic),

		sci_base_state_machine_change_state(&scic->parent.state_machine,

						    SCI_BASE_CONTROLLER_STATE_READY);



		isci_host_start_complete(ihost, status);
@@ -751,18 +750,12 @@ void scic_sds_controller_timeout_handler(void *_scic) 
{

	struct scic_sds_controller *scic = _scic;

	struct isci_host *ihost = sci_object_get_association(scic);

	enum sci_base_controller_states current_state;



	current_state = sci_base_state_machine_get_state(

		scic_sds_controller_get_base_state_machine(scic));

	struct sci_base_state_machine *sm = &scic->parent.state_machine;



	if (current_state == SCI_BASE_CONTROLLER_STATE_STARTING) {

		scic_sds_controller_transition_to_ready(

			scic, SCI_FAILURE_TIMEOUT);

	} else if (current_state == SCI_BASE_CONTROLLER_STATE_STOPPING) {

		sci_base_state_machine_change_state(

			scic_sds_controller_get_base_state_machine(scic),

			SCI_BASE_CONTROLLER_STATE_FAILED);

	if (sm->current_state_id == SCI_BASE_CONTROLLER_STATE_STARTING)

		scic_sds_controller_transition_to_ready(scic, SCI_FAILURE_TIMEOUT);

	else if (sm->current_state_id == SCI_BASE_CONTROLLER_STATE_STOPPING) {

		sci_base_state_machine_change_state(sm, SCI_BASE_CONTROLLER_STATE_FAILED);

		isci_host_stop_complete(ihost, SCI_FAILURE_TIMEOUT);

	} else	/* / @todo Now what do we want to do in this case? */

		dev_err(scic_to_dev(scic),
@@ -1619,16 +1612,15 @@ void scic_sds_controller_error_handler(struct scic_sds_controller *scic) 
		dev_err(scic_to_dev(scic), "%s: status: %#x\n", __func__,

			interrupt_status);



		sci_base_state_machine_change_state(

			scic_sds_controller_get_base_state_machine(scic),

		sci_base_state_machine_change_state(&scic->parent.state_machine,

						    SCI_BASE_CONTROLLER_STATE_FAILED);



		return;

	}



	/*

	 * If we dont process any completions I am not sure that we want to do this.

	 * We are in the middle of a hardware fault and should probably be reset. */

	/* If we dont process any completions I am not sure that we want to do this.

	 * We are in the middle of a hardware fault and should probably be reset.

	 */

	SMU_IMR_WRITE(scic, 0x00000000);

}
@@ -1655,12 +1647,8 @@ void scic_sds_controller_link_up( 
	else

		dev_dbg(scic_to_dev(scic),

			"%s: SCIC Controller linkup event from phy %d in "

			"unexpected state %d\n",

			__func__,

			sci_phy->phy_index,

			sci_base_state_machine_get_state(

				scic_sds_controller_get_base_state_machine(

					scic)));

			"unexpected state %d\n", __func__, sci_phy->phy_index,

			state);

}
@@ -2125,11 +2113,7 @@ enum sci_status scic_controller_initialize( 
	else

		dev_warn(scic_to_dev(scic),

			 "%s: SCIC Controller initialize operation requested "

			 "in invalid state %d\n",

			 __func__,

			 sci_base_state_machine_get_state(

				 scic_sds_controller_get_base_state_machine(

					 scic)));

			 "in invalid state %d\n",  __func__, state);



	return status;

}
@@ -2180,11 +2164,7 @@ enum sci_status scic_controller_start( 
	else

		dev_warn(scic_to_dev(scic),

			 "%s: SCIC Controller start operation requested in "

			 "invalid state %d\n",

			 __func__,

			 sci_base_state_machine_get_state(

				 scic_sds_controller_get_base_state_machine(

					 scic)));

			 "invalid state %d\n", __func__, state);



	return status;

}
@@ -2207,11 +2187,7 @@ enum sci_status scic_controller_stop( 
	else

		dev_warn(scic_to_dev(scic),

			 "%s: SCIC Controller stop operation requested in "

			 "invalid state %d\n",

			 __func__,

			 sci_base_state_machine_get_state(

				 scic_sds_controller_get_base_state_machine(

					 scic)));

			 "invalid state %d\n", __func__, state);



	return status;

}
@@ -2233,11 +2209,7 @@ enum sci_status scic_controller_reset( 
	else

		dev_warn(scic_to_dev(scic),

			 "%s: SCIC Controller reset operation requested in "

			 "invalid state %d\n",

			 __func__,

			 sci_base_state_machine_get_state(

				 scic_sds_controller_get_base_state_machine(

					 scic)));

			 "invalid state %d\n",  __func__, state);



	return status;

}
@@ -2765,128 +2737,57 @@ struct scic_sds_controller *scic_controller_alloc(struct device *dev) 
	return devm_kzalloc(dev, sizeof(struct scic_sds_controller), GFP_KERNEL);

}



/*

 * *****************************************************************************

 * * DEFAULT STATE HANDLERS

 * ***************************************************************************** */

static enum sci_status default_controller_handler(struct sci_base_controller *base_scic,

						  const char *func)

{

	struct scic_sds_controller *scic = container_of(base_scic, typeof(*scic), parent);

	u32 state = base_scic->state_machine.current_state_id;



	dev_warn(scic_to_dev(scic), "%s: invalid state %d\n", func, state);



	return SCI_FAILURE_INVALID_STATE;

}



/**

 *

 * @controller: This is struct sci_base_controller object which is cast into a

 *    struct scic_sds_controller object.

 * @remote_device: This is struct sci_base_remote_device which, if it was used, would

 *    be cast to a struct scic_sds_remote_device.

 * @io_request: This is the struct sci_base_request which, if it was used, would be

 *    cast to a SCIC_SDS_IO_REQUEST.

 * @io_tag: This is the IO tag to be assigned to the IO request or

 *    SCI_CONTROLLER_INVALID_IO_TAG.

 *

 * This method is called when the struct scic_sds_controller default start io/task

 * handler is in place. - Issue a warning message enum sci_status

 * SCI_FAILURE_INVALID_STATE

 */

static enum sci_status scic_sds_controller_default_start_operation_handler(

	struct sci_base_controller *controller,

	struct sci_base_controller *base_scic,

	struct sci_base_remote_device *remote_device,

	struct sci_base_request *io_request,

	u16 io_tag)

{

	struct scic_sds_controller *this_controller;



	this_controller = (struct scic_sds_controller *)controller;



	dev_warn(scic_to_dev(this_controller),

		 "%s: SCIC Controller requested to start an io/task from "

		 "invalid state %d\n",

		 __func__,

		 sci_base_state_machine_get_state(

			 scic_sds_controller_get_base_state_machine(

				 this_controller)));



	return SCI_FAILURE_INVALID_STATE;

	return default_controller_handler(base_scic, __func__);

}



/**

 *

 * @controller: This is struct sci_base_controller object which is cast into a

 *    struct scic_sds_controller object.

 * @remote_device: This is struct sci_base_remote_device which, if it was used, would

 *    be cast to a struct scic_sds_remote_device.

 * @io_request: This is the struct sci_base_request which, if it was used, would be

 *    cast to a SCIC_SDS_IO_REQUEST.

 *

 * This method is called when the struct scic_sds_controller default request handler

 * is in place. - Issue a warning message enum sci_status SCI_FAILURE_INVALID_STATE

 */

static enum sci_status scic_sds_controller_default_request_handler(

	struct sci_base_controller *controller,

	struct sci_base_controller *base_scic,

	struct sci_base_remote_device *remote_device,

	struct sci_base_request *io_request)

{

	struct scic_sds_controller *this_controller;



	this_controller = (struct scic_sds_controller *)controller;



	dev_warn(scic_to_dev(this_controller),

		"%s: SCIC Controller request operation from invalid state %d\n",

		__func__,

		sci_base_state_machine_get_state(

			scic_sds_controller_get_base_state_machine(

				this_controller)));



	return SCI_FAILURE_INVALID_STATE;

	return default_controller_handler(base_scic, __func__);

}



/*

 * *****************************************************************************

 * * GENERAL (COMMON) STATE HANDLERS

 * ***************************************************************************** */



/**

 *

 * @controller: The struct sci_base_controller object which is cast into a

 *    struct scic_sds_controller object.

 *

 * This method is called when the struct scic_sds_controller is in the ready state

 * reset handler is in place. - Transition to

 * SCI_BASE_CONTROLLER_STATE_RESETTING enum sci_status SCI_SUCCESS

 */

static enum sci_status scic_sds_controller_general_reset_handler(

	struct sci_base_controller *controller)

static enum sci_status scic_sds_controller_general_reset_handler(struct sci_base_controller *base_scic)

{

	struct scic_sds_controller *this_controller;



	this_controller = (struct scic_sds_controller *)controller;



	/*

	 * The reset operation is not a graceful cleanup just perform the state

	 * transition. */

	sci_base_state_machine_change_state(

		scic_sds_controller_get_base_state_machine(this_controller),

		SCI_BASE_CONTROLLER_STATE_RESETTING

		);

	/* The reset operation is not a graceful cleanup just perform the state

	 * transition.

	 */

	sci_base_state_machine_change_state(&base_scic->state_machine,

					    SCI_BASE_CONTROLLER_STATE_RESETTING);



	return SCI_SUCCESS;

}



/*

 * *****************************************************************************

 * * RESET STATE HANDLERS

 * ***************************************************************************** */



static enum sci_status scic_sds_controller_reset_state_initialize_handler(struct sci_base_controller *base_scic)

{

	struct sci_base_state_machine *sm = &base_scic->state_machine;

	enum sci_status result = SCI_SUCCESS;

	struct scic_sds_controller *scic;

	struct isci_host *ihost;

	u32 index;

	u32 index, state;



	scic = container_of(base_scic, typeof(*scic), parent);

	ihost = sci_object_get_association(scic);



	sci_base_state_machine_change_state(

		scic_sds_controller_get_base_state_machine(scic),

		SCI_BASE_CONTROLLER_STATE_INITIALIZING);

	sci_base_state_machine_change_state(sm, SCI_BASE_CONTROLLER_STATE_INITIALIZING);



	scic->timeout_timer = isci_timer_create(ihost,

						scic,
@@ -3028,13 +2929,10 @@ static enum sci_status scic_sds_controller_reset_state_initialize_handler(struct 


	/* Advance the controller state machine */

	if (result == SCI_SUCCESS)

		sci_base_state_machine_change_state(

			scic_sds_controller_get_base_state_machine(scic),

			SCI_BASE_CONTROLLER_STATE_INITIALIZED);

		state = SCI_BASE_CONTROLLER_STATE_INITIALIZED;

	else

		sci_base_state_machine_change_state(

			scic_sds_controller_get_base_state_machine(scic),

			SCI_BASE_CONTROLLER_STATE_FAILED);

		state = SCI_BASE_CONTROLLER_STATE_FAILED;

	sci_base_state_machine_change_state(sm, state);



	return result;

}
@@ -3065,14 +2963,14 @@ static enum sci_status scic_sds_controller_reset_state_initialize_handler(struct 
 * descriptor fields is invalid.

 */

static enum sci_status scic_sds_controller_initialized_state_start_handler(

	struct sci_base_controller *controller,

	struct sci_base_controller *base_scic,

	u32 timeout)

{

	u16 index;

	enum sci_status result;

	struct scic_sds_controller *scic;



	scic = (struct scic_sds_controller *)controller;

	scic = container_of(base_scic, typeof(*scic), parent);



	/*

	 * Make sure that the SCI User filled in the memory descriptor
@@ -3135,8 +3033,7 @@ static enum sci_status scic_sds_controller_initialized_state_start_handler( 


		isci_timer_start(scic->timeout_timer, timeout);



		sci_base_state_machine_change_state(

			scic_sds_controller_get_base_state_machine(scic),

		sci_base_state_machine_change_state(&base_scic->state_machine,

						    SCI_BASE_CONTROLLER_STATE_STARTING);

	}
@@ -3197,32 +3094,14 @@ static void scic_sds_controller_starting_state_link_down_handler( 
	/* scic_sds_port_link_down(port, phy); */

}



/*

 * *****************************************************************************

 * * READY STATE HANDLERS

 * ***************************************************************************** */



/**

 *

 * @controller: The struct sci_base_controller object which is cast into a

 *    struct scic_sds_controller object.

 * @timeout: The timeout for when the stop operation should report a failure.

 *

 * This method is called when the struct scic_sds_controller is in the ready state

 * stop handler is called. - Start the timeout timer - Transition to

 * SCI_BASE_CONTROLLER_STATE_STOPPING. enum sci_status SCI_SUCCESS

 */

static enum sci_status scic_sds_controller_ready_state_stop_handler(

	struct sci_base_controller *controller,

static enum sci_status scic_sds_controller_ready_state_stop_handler(struct sci_base_controller *base_scic,

								    u32 timeout)

{

	struct scic_sds_controller *scic =

		(struct scic_sds_controller *)controller;

	struct scic_sds_controller *scic;



	scic = container_of(base_scic, typeof(*scic), parent);

	isci_timer_start(scic->timeout_timer, timeout);



	sci_base_state_machine_change_state(

		scic_sds_controller_get_base_state_machine(scic),

	sci_base_state_machine_change_state(&base_scic->state_machine,

					    SCI_BASE_CONTROLLER_STATE_STOPPING);



	return SCI_SUCCESS;
@@ -3749,33 +3628,16 @@ static inline void scic_sds_controller_stopping_state_exit( 
	isci_timer_stop(scic->timeout_timer);

}



/**

 *

 * @object: This is the struct sci_base_object which is cast to a struct scic_sds_controller

 *    object.

 *

 * This method implements the actions taken by the struct scic_sds_controller on entry

 * to the SCI_BASE_CONTROLLER_STATE_RESETTING. - Set the state handlers to the

 * controllers resetting state. - Write to the SCU hardware reset register to

 * force a reset - Transition to the SCI_BASE_CONTROLLER_STATE_RESET none

 */

static void scic_sds_controller_resetting_state_enter(

	struct sci_base_object *object)

static void scic_sds_controller_resetting_state_enter(struct sci_base_object *object)

{

	struct scic_sds_controller *this_controller;



	this_controller = (struct scic_sds_controller *)object;



	scic_sds_controller_reset_hardware(this_controller);

	struct scic_sds_controller *scic;



	sci_base_state_machine_change_state(

		scic_sds_controller_get_base_state_machine(this_controller),

		SCI_BASE_CONTROLLER_STATE_RESET

		);

	scic = container_of(object, typeof(*scic), parent.parent);

	scic_sds_controller_reset_hardware(scic);

	sci_base_state_machine_change_state(&scic->parent.state_machine,

					    SCI_BASE_CONTROLLER_STATE_RESET);

}



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



const struct sci_base_state scic_sds_controller_state_table[] = {

	[SCI_BASE_CONTROLLER_STATE_INITIAL] = {

		.enter_state = scic_sds_controller_initial_state_enter,
@@ -3800,4 +3662,3 @@ const struct sci_base_state scic_sds_controller_state_table[] = { 
	[SCI_BASE_CONTROLLER_STATE_STOPPED] = {},

	[SCI_BASE_CONTROLLER_STATE_FAILED] = {}

};

drivers/scsi/isci/core/scic_sds_controller.h

+0 −9
Original line number Diff line number Diff line
@@ -420,15 +420,6 @@ extern const struct sci_base_state scic_sds_controller_state_table[]; 
		} \

	}



/**

 * scic_sds_controller_get_base_state_machine() -

 *

 * This is a helper macro that gets the base state machine for the controller

 * object

 */

#define scic_sds_controller_get_base_state_machine(this_controller) \

	(&(this_controller)->parent.state_machine)



/**

 * scic_sds_controller_get_port_configuration_agent() -

 *

drivers/scsi/isci/core/scic_sds_phy.c

+135 −265

File changed.

Preview size limit exceeded, changes collapsed.

drivers/scsi/isci/core/scic_sds_phy.h

+0 −48
Original line number Diff line number Diff line
@@ -316,24 +316,6 @@ extern const struct scic_sds_phy_state_handler scic_sds_phy_starting_substate_ha 
#define scic_sds_phy_get_controller(phy) \

	(scic_sds_port_get_controller((phy)->owning_port))



/**

 * scic_sds_phy_get_base_state_machine() - This macro returns the state machine

 *    for the base phy

 *

 *

 */

#define scic_sds_phy_get_base_state_machine(phy) \

	(&(phy)->parent.state_machine)



/**

 * scic_sds_phy_get_starting_substate_machine() - This macro returns the

 *    starting substate machine for this phy

 *

 *

 */

#define scic_sds_phy_get_starting_substate_machine(phy)	\

	(&(phy)->starting_substate_machine)



/**

 * scic_sds_phy_set_state_handlers() - This macro sets the state handlers for

 *    this phy object
@@ -354,27 +336,6 @@ extern const struct scic_sds_phy_state_handler scic_sds_phy_starting_substate_ha 
		&scic_sds_phy_state_handler_table[(state_id)] \

		)



/**

 * scic_sds_phy_is_ready() -

 *

 * This macro returns true if the current base state for this phy is

 * SCI_BASE_PHY_STATE_READY

 */

#define scic_sds_phy_is_ready(phy) \

	(\

		SCI_BASE_PHY_STATE_READY \

		== sci_base_state_machine_get_state(\

			scic_sds_phy_get_base_state_machine(phy) \

			) \

	)



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









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



void scic_sds_phy_construct(

	struct scic_sds_phy *this_phy,

	struct scic_sds_port *owning_port,
@@ -404,8 +365,6 @@ enum sci_status scic_sds_phy_reset( 
void scic_sds_phy_sata_timeout(

	void *cookie);



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



void scic_sds_phy_suspend(

	struct scic_sds_phy *this_phy);
@@ -416,8 +375,6 @@ void scic_sds_phy_setup_transport( 
	struct scic_sds_phy *this_phy,

	u32 device_id);



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



enum sci_status scic_sds_phy_event_handler(

	struct scic_sds_phy *this_phy,

	u32 event_code);
@@ -445,11 +402,6 @@ void scic_sds_phy_get_attached_phy_protocols( 
	struct scic_sds_phy *this_phy,

	struct sci_sas_identify_address_frame_protocols *protocols);



/*

 * ****************************************************************************-

 * * SCIC SDS PHY Handler Methods

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



enum sci_status scic_sds_phy_default_start_handler(

	struct sci_base_phy *phy);

drivers/scsi/isci/core/scic_sds_port.c

+90 −334

File changed.

Preview size limit exceeded, changes collapsed.