host.h 16.6 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54
/*
 * 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.
 */
D
Dan Williams 已提交
55
#ifndef _SCI_HOST_H_
56 57 58
#define _SCI_HOST_H_

#include "remote_device.h"
D
Dan Williams 已提交
59
#include "phy.h"
60
#include "isci.h"
61
#include "remote_node_table.h"
62 63
#include "registers.h"
#include "unsolicited_frame_control.h"
D
Dan Williams 已提交
64
#include "probe_roms.h"
65

66
struct isci_request;
67 68
struct scu_task_context;

D
Dan Williams 已提交
69

70
/**
71
 * struct sci_power_control -
72 73 74 75
 *
 * This structure defines the fields for managing power control for direct
 * attached disk devices.
 */
76
struct sci_power_control {
77 78 79 80 81 82 83
	/**
	 * This field is set when the power control timer is running and cleared when
	 * it is not.
	 */
	bool timer_started;

	/**
84
	 * Timer to control when the directed attached disks can consume power.
85
	 */
86
	struct sci_timer timer;
87 88 89 90 91 92 93 94 95 96 97 98 99 100

	/**
	 * This field is used to keep track of how many phys are put into the
	 * requesters field.
	 */
	u8 phys_waiting;

	/**
	 * This field is used to keep track of how many phys have been granted to consume power
	 */
	u8 phys_granted_power;

	/**
	 * This field is an array of phys that we are waiting on. The phys are direct
101
	 * mapped into requesters via struct sci_phy.phy_index
102
	 */
103
	struct isci_phy *requesters[SCI_MAX_PHYS];
104 105 106

};

107
struct sci_port_configuration_agent;
108
typedef void (*port_config_fn)(struct isci_host *,
109
			       struct sci_port_configuration_agent *,
110
			       struct isci_port *, struct isci_phy *);
D
Dan Williams 已提交
111

112
struct sci_port_configuration_agent {
D
Dan Williams 已提交
113 114 115 116 117 118 119 120 121
	u16 phy_configured_mask;
	u16 phy_ready_mask;
	struct {
		u8 min_index;
		u8 max_index;
	} phy_valid_port_range[SCI_MAX_PHYS];
	bool timer_pending;
	port_config_fn link_up_handler;
	port_config_fn link_down_handler;
122
	struct sci_timer	timer;
D
Dan Williams 已提交
123 124
};

125
/**
126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144
 * 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.

145
 */
146
struct isci_host {
E
Edmund Nadolski 已提交
147
	struct sci_base_state_machine sm;
148
	/* XXX can we time this externally */
149
	struct sci_timer timer;
150
	/* XXX drop reference module params directly */
151
	struct sci_user_parameters user_parameters;
152
	/* XXX no need to be a union */
153 154
	struct sci_oem_params oem_parameters;
	struct sci_port_configuration_agent port_agent;
155
	struct isci_remote_device *device_table[SCI_MAX_REMOTE_DEVICES];
156 157
	struct sci_remote_node_table available_remote_nodes;
	struct sci_power_control power_control;
D
Dan Williams 已提交
158
	u8 io_request_sequence[SCI_MAX_IO_REQUESTS];
159
	struct scu_task_context *task_context_table;
160
	dma_addr_t task_context_dma;
161 162 163 164 165 166
	union scu_remote_node_context *remote_node_context_table;
	u32 *completion_queue;
	u32 completion_queue_get;
	u32 logical_port_entries;
	u32 remote_node_entries;
	u32 task_context_entries;
167
	struct sci_unsolicited_frame_control uf_control;
168

169
	/* phy startup */
170
	struct sci_timer phy_timer;
171
	/* XXX kill */
172 173
	bool phy_startup_timer_pending;
	u32 next_phy_to_start;
D
Dan Williams 已提交
174
	/* XXX convert to unsigned long and use bitops */
175 176
	u8 invalid_phy_mask;

177
	/* TODO attempt dynamic interrupt coalescing scheme */
178 179 180 181 182
	u16 interrupt_coalesce_number;
	u32 interrupt_coalesce_timeout;
	struct smu_registers __iomem *smu_registers;
	struct scu_registers __iomem *scu_registers;

183 184 185 186
	u16 tci_head;
	u16 tci_tail;
	u16 tci_pool[SCI_MAX_IO_REQUESTS];

187 188
	int id; /* unique within a given pci device */
	struct isci_phy phys[SCI_MAX_PHYS];
D
Dan Williams 已提交
189
	struct isci_port ports[SCI_MAX_PORTS + 1]; /* includes dummy port */
190 191 192 193 194
	struct sas_ha_struct sas_ha;

	spinlock_t state_lock;
	struct pci_dev *pdev;
	enum isci_status status;
195 196 197 198
	#define IHOST_START_PENDING 0
	#define IHOST_STOP_PENDING 1
	unsigned long flags;
	wait_queue_head_t eventq;
199 200 201
	struct Scsi_Host *shost;
	struct tasklet_struct completion_tasklet;
	struct list_head requests_to_complete;
202
	struct list_head requests_to_errorback;
203
	spinlock_t scic_lock;
D
Dan Williams 已提交
204
	struct isci_request *reqs[SCI_MAX_IO_REQUESTS];
205
	struct isci_remote_device devices[SCI_MAX_REMOTE_DEVICES];
206 207
};

208
/**
209
 * enum sci_controller_states - This enumeration depicts all the states
210 211
 *    for the common controller state machine.
 */
212
enum sci_controller_states {
213 214 215
	/**
	 * Simply the initial state for the base controller state machine.
	 */
E
Edmund Nadolski 已提交
216
	SCIC_INITIAL = 0,
217 218 219 220 221 222 223 224

	/**
	 * This state indicates that the controller is reset.  The memory for
	 * the controller is in it's initial state, but the controller requires
	 * initialization.
	 * This state is entered from the INITIAL state.
	 * This state is entered from the RESETTING state.
	 */
E
Edmund Nadolski 已提交
225
	SCIC_RESET,
226 227 228 229 230 231 232

	/**
	 * This state is typically an action state that indicates the controller
	 * is in the process of initialization.  In this state no new IO operations
	 * are permitted.
	 * This state is entered from the RESET state.
	 */
E
Edmund Nadolski 已提交
233
	SCIC_INITIALIZING,
234 235 236 237 238 239

	/**
	 * This state indicates that the controller has been successfully
	 * initialized.  In this state no new IO operations are permitted.
	 * This state is entered from the INITIALIZING state.
	 */
E
Edmund Nadolski 已提交
240
	SCIC_INITIALIZED,
241 242 243 244 245 246

	/**
	 * This state indicates the the controller is in the process of becoming
	 * ready (i.e. starting).  In this state no new IO operations are permitted.
	 * This state is entered from the INITIALIZED state.
	 */
E
Edmund Nadolski 已提交
247
	SCIC_STARTING,
248 249 250 251 252 253

	/**
	 * This state indicates the controller is now ready.  Thus, the user
	 * is able to perform IO operations on the controller.
	 * This state is entered from the STARTING state.
	 */
E
Edmund Nadolski 已提交
254
	SCIC_READY,
255 256 257 258 259 260 261 262 263 264

	/**
	 * This state is typically an action state that indicates the controller
	 * is in the process of resetting.  Thus, the user is unable to perform
	 * IO operations on the controller.  A reset is considered destructive in
	 * most cases.
	 * This state is entered from the READY state.
	 * This state is entered from the FAILED state.
	 * This state is entered from the STOPPED state.
	 */
E
Edmund Nadolski 已提交
265
	SCIC_RESETTING,
266 267 268 269 270 271 272

	/**
	 * This state indicates that the controller 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.
	 */
E
Edmund Nadolski 已提交
273
	SCIC_STOPPING,
274 275 276 277 278 279

	/**
	 * This state indicates that the controller has successfully been stopped.
	 * In this state no new IO operations are permitted.
	 * This state is entered from the STOPPING state.
	 */
E
Edmund Nadolski 已提交
280
	SCIC_STOPPED,
281 282 283 284 285 286 287 288 289

	/**
	 * This state indicates that the controller could not successfully be
	 * initialized.  In this state no new IO operations are permitted.
	 * This state is entered from the INITIALIZING state.
	 * This state is entered from the STARTING state.
	 * This state is entered from the STOPPING state.
	 * This state is entered from the RESETTING state.
	 */
E
Edmund Nadolski 已提交
290
	SCIC_FAILED,
291 292
};

293 294 295 296 297 298 299 300 301
/**
 * 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 (SCI_NUM_MSI_X_INT*SCI_MAX_CONTROLLERS)

struct isci_pci_info {
	struct msix_entry msix_entries[SCI_MAX_MSIX_INT];
302
	struct isci_host *hosts[SCI_MAX_CONTROLLERS];
303
	struct isci_orom *orom;
304 305 306 307 308 309 310
};

static inline struct isci_pci_info *to_pci_info(struct pci_dev *pdev)
{
	return pci_get_drvdata(pdev);
}

311 312 313 314
#define for_each_isci_host(id, ihost, pdev) \
	for (id = 0, ihost = to_pci_info(pdev)->hosts[id]; \
	     id < ARRAY_SIZE(to_pci_info(pdev)->hosts) && ihost; \
	     ihost = to_pci_info(pdev)->hosts[++id])
315

316
static inline enum isci_status isci_host_get_state(struct isci_host *isci_host)
317 318 319 320
{
	return isci_host->status;
}

321 322
static inline void isci_host_change_state(struct isci_host *isci_host,
					  enum isci_status status)
323 324 325 326 327 328 329 330 331 332 333 334 335 336
{
	unsigned long flags;

	dev_dbg(&isci_host->pdev->dev,
		"%s: isci_host = %p, state = 0x%x",
		__func__,
		isci_host,
		status);
	spin_lock_irqsave(&isci_host->state_lock, flags);
	isci_host->status = status;
	spin_unlock_irqrestore(&isci_host->state_lock, flags);

}

337 338 339 340 341 342 343 344 345 346
static inline void wait_for_start(struct isci_host *ihost)
{
	wait_event(ihost->eventq, !test_bit(IHOST_START_PENDING, &ihost->flags));
}

static inline void wait_for_stop(struct isci_host *ihost)
{
	wait_event(ihost->eventq, !test_bit(IHOST_STOP_PENDING, &ihost->flags));
}

347 348 349 350 351 352 353
static inline void wait_for_device_start(struct isci_host *ihost, struct isci_remote_device *idev)
{
	wait_event(ihost->eventq, !test_bit(IDEV_START_PENDING, &idev->flags));
}

static inline void wait_for_device_stop(struct isci_host *ihost, struct isci_remote_device *idev)
{
D
Dan Williams 已提交
354
	wait_event(ihost->eventq, !test_bit(IDEV_STOP_PENDING, &idev->flags));
355
}
356

357 358 359 360
static inline struct isci_host *dev_to_ihost(struct domain_device *dev)
{
	return dev->port->ha->lldd_ha;
}
361

D
Dan Williams 已提交
362 363
/* we always use protocol engine group zero */
#define ISCI_PEG 0
364

365
/* see sci_controller_io_tag_allocate|free for how seq and tci are built */
D
Dan Williams 已提交
366
#define ISCI_TAG(seq, tci) (((u16) (seq)) << 12 | tci)
367

D
Dan Williams 已提交
368 369 370
/* these are returned by the hardware, so sanitize them */
#define ISCI_TAG_SEQ(tag) (((tag) >> 12) & (SCI_MAX_SEQ-1))
#define ISCI_TAG_TCI(tag) ((tag) & (SCI_MAX_IO_REQUESTS-1))
371 372

/* expander attached sata devices require 3 rnc slots */
373
static inline int sci_remote_device_node_count(struct isci_remote_device *idev)
374
{
375
	struct domain_device *dev = idev->domain_dev;
376 377

	if ((dev->dev_type == SATA_DEV || (dev->tproto & SAS_PROTOCOL_STP)) &&
378
	    !idev->is_direct_attached)
379 380 381 382 383
		return SCU_STP_REMOTE_NODE_COUNT;
	return SCU_SSP_REMOTE_NODE_COUNT;
}

/**
384
 * sci_controller_clear_invalid_phy() -
385 386 387 388 389
 *
 * 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.
 */
390
#define sci_controller_clear_invalid_phy(controller, phy) \
391 392
	((controller)->invalid_phy_mask &= ~(1 << (phy)->phy_index))

393
static inline struct device *sciphy_to_dev(struct isci_phy *iphy)
394 395 396 397 398 399 400 401
{

	if (!iphy || !iphy->isci_port || !iphy->isci_port->isci_host)
		return NULL;

	return &iphy->isci_port->isci_host->pdev->dev;
}

402
static inline struct device *sciport_to_dev(struct isci_port *iport)
403 404 405 406 407 408 409 410
{

	if (!iport || !iport->isci_host)
		return NULL;

	return &iport->isci_host->pdev->dev;
}

411
static inline struct device *scirdev_to_dev(struct isci_remote_device *idev)
412 413 414 415 416 417 418 419 420 421 422
{
	if (!idev || !idev->isci_port || !idev->isci_port->isci_host)
		return NULL;

	return &idev->isci_port->isci_host->pdev->dev;
}

enum {
	ISCI_SI_REVA0,
	ISCI_SI_REVA2,
	ISCI_SI_REVB0,
423
	ISCI_SI_REVC0
424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439
};

extern int isci_si_rev;

static inline bool is_a0(void)
{
	return isci_si_rev == ISCI_SI_REVA0;
}

static inline bool is_a2(void)
{
	return isci_si_rev == ISCI_SI_REVA2;
}

static inline bool is_b0(void)
{
440 441 442 443 444 445
	return isci_si_rev == ISCI_SI_REVB0;
}

static inline bool is_c0(void)
{
	return isci_si_rev > ISCI_SI_REVB0;
446 447
}

448
void sci_controller_post_request(struct isci_host *ihost,
449
				      u32 request);
450
void sci_controller_release_frame(struct isci_host *ihost,
451
				       u32 frame_index);
452
void sci_controller_copy_sata_response(void *response_buffer,
453 454
					    void *frame_header,
					    void *frame_buffer);
455
enum sci_status sci_controller_allocate_remote_node_context(struct isci_host *ihost,
456
								 struct isci_remote_device *idev,
457
								 u16 *node_id);
458
void sci_controller_free_remote_node_context(
459
	struct isci_host *ihost,
460
	struct isci_remote_device *idev,
461 462
	u16 node_id);

463
struct isci_request *sci_request_by_tag(struct isci_host *ihost,
464 465
					     u16 io_tag);

466
void sci_controller_power_control_queue_insert(
467
	struct isci_host *ihost,
468
	struct isci_phy *iphy);
469

470
void sci_controller_power_control_queue_remove(
471
	struct isci_host *ihost,
472
	struct isci_phy *iphy);
473

474
void sci_controller_link_up(
475
	struct isci_host *ihost,
476
	struct isci_port *iport,
477
	struct isci_phy *iphy);
478

479
void sci_controller_link_down(
480
	struct isci_host *ihost,
481
	struct isci_port *iport,
482
	struct isci_phy *iphy);
483

484
void sci_controller_remote_device_stopped(
485
	struct isci_host *ihost,
486
	struct isci_remote_device *idev);
487

488
void sci_controller_copy_task_context(
489
	struct isci_host *ihost,
490
	struct isci_request *ireq);
491

492
void sci_controller_register_setup(struct isci_host *ihost);
493

494
enum sci_status sci_controller_continue_io(struct isci_request *ireq);
495 496
int isci_host_scan_finished(struct Scsi_Host *, unsigned long);
void isci_host_scan_start(struct Scsi_Host *);
497 498 499
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);
500 501 502 503 504 505 506 507 508 509 510 511

int isci_host_init(struct isci_host *);

void isci_host_init_controller_names(
	struct isci_host *isci_host,
	unsigned int controller_idx);

void isci_host_deinit(
	struct isci_host *);

void isci_host_port_link_up(
	struct isci_host *,
512
	struct isci_port *,
513
	struct isci_phy *);
514 515 516 517 518 519 520
int isci_host_dev_found(struct domain_device *);

void isci_host_remote_device_start_complete(
	struct isci_host *,
	struct isci_remote_device *,
	enum sci_status);

521
void sci_controller_disable_interrupts(
522
	struct isci_host *ihost);
523

524
enum sci_status sci_controller_start_io(
525
	struct isci_host *ihost,
526
	struct isci_remote_device *idev,
527
	struct isci_request *ireq);
528

529
enum sci_task_status sci_controller_start_task(
530
	struct isci_host *ihost,
531
	struct isci_remote_device *idev,
532
	struct isci_request *ireq);
533

534
enum sci_status sci_controller_terminate_request(
535
	struct isci_host *ihost,
536
	struct isci_remote_device *idev,
537
	struct isci_request *ireq);
538

539
enum sci_status sci_controller_complete_io(
540
	struct isci_host *ihost,
541
	struct isci_remote_device *idev,
542
	struct isci_request *ireq);
543

544 545
void sci_port_configuration_agent_construct(
	struct sci_port_configuration_agent *port_agent);
D
Dan Williams 已提交
546

547
enum sci_status sci_port_configuration_agent_initialize(
548
	struct isci_host *ihost,
549
	struct sci_port_configuration_agent *port_agent);
550
#endif