blob: 81292392adbcdf9142de2a97a83b14b44f335cfe [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * Transport specific attributes.
3 *
4 * Copyright (c) 2003 Silicon Graphics, Inc. All rights reserved.
5 *
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19 */
20#ifndef SCSI_TRANSPORT_H
21#define SCSI_TRANSPORT_H
22
23#include <linux/transport_class.h>
Jens Axboe242f9dc2008-09-14 05:55:09 -070024#include <linux/blkdev.h>
Paul Gortmaker187f1882011-11-23 20:12:59 -050025#include <linux/bug.h>
James Bottomleyc3e9dda2005-05-24 16:57:31 -050026#include <scsi/scsi_host.h>
Rolf Eike Beera9b73202007-02-16 01:46:25 -080027#include <scsi/scsi_device.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070028
29struct scsi_transport_template {
30 /* the attribute containers */
31 struct transport_container host_attrs;
32 struct transport_container target_attrs;
33 struct transport_container device_attrs;
34
James.Smart@Emulex.Com5c44cd22005-06-10 22:24:30 -040035 /*
Christoph Hellwige02f3f52006-01-13 19:04:00 +010036 * If set, called from sysfs and legacy procfs rescanning code.
James.Smart@Emulex.Com5c44cd22005-06-10 22:24:30 -040037 */
Hannes Reinecke9cb78c12014-06-25 15:27:36 +020038 int (*user_scan)(struct Scsi_Host *, uint, uint, u64);
James.Smart@Emulex.Com5c44cd22005-06-10 22:24:30 -040039
Linus Torvalds1da177e2005-04-16 15:20:36 -070040 /* The size of the specific transport attribute structure (a
41 * space of this size will be left at the end of the
42 * scsi_* structure */
43 int device_size;
James Bottomleyc3e9dda2005-05-24 16:57:31 -050044 int device_private_offset;
Linus Torvalds1da177e2005-04-16 15:20:36 -070045 int target_size;
James Bottomleyc3e9dda2005-05-24 16:57:31 -050046 int target_private_offset;
Linus Torvalds1da177e2005-04-16 15:20:36 -070047 int host_size;
James Bottomleyc3e9dda2005-05-24 16:57:31 -050048 /* no private offset for the host; there's an alternative mechanism */
Linus Torvalds1da177e2005-04-16 15:20:36 -070049
50 /*
51 * True if the transport wants to use a host-based work-queue
52 */
53 unsigned int create_work_queue : 1;
James Smartc829c392006-03-13 08:28:57 -050054
55 /*
Christoph Hellwig9227c332006-04-01 19:21:04 +020056 * Allows a transport to override the default error handler.
57 */
58 void (* eh_strategy_handler)(struct Scsi_Host *);
59
60 /*
James Smartc829c392006-03-13 08:28:57 -050061 * This is an optional routine that allows the transport to become
62 * involved when a scsi io timer fires. The return value tells the
63 * timer routine how to finish the io timeout handling:
64 * EH_HANDLED: I fixed the error, please complete the command
65 * EH_RESET_TIMER: I need more time, reset the timer and
66 * begin counting again
67 * EH_NOT_HANDLED Begin normal error recovery
68 */
Jens Axboe242f9dc2008-09-14 05:55:09 -070069 enum blk_eh_timer_return (*eh_timed_out)(struct scsi_cmnd *);
FUJITA Tomonori2c47f9ef2007-07-11 15:08:17 +090070
71 /*
72 * Used as callback for the completion of i_t_nexus request
73 * for target drivers.
74 */
75 int (* it_nexus_response)(struct Scsi_Host *, u64, int);
FUJITA Tomonoribfb74372007-07-11 15:08:22 +090076
77 /*
78 * Used as callback for the completion of task management
79 * request for target drivers.
80 */
81 int (* tsk_mgmt_response)(struct Scsi_Host *, u64, u64, int);
Linus Torvalds1da177e2005-04-16 15:20:36 -070082};
83
84#define transport_class_to_shost(tc) \
Tony Jonesee959b02008-02-22 00:13:36 +010085 dev_to_shost((tc)->parent)
Linus Torvalds1da177e2005-04-16 15:20:36 -070086
87
James Bottomleyc3e9dda2005-05-24 16:57:31 -050088/* Private area maintenance. The driver requested allocations come
89 * directly after the transport class allocations (if any). The idea
90 * is that you *must* call these only once. The code assumes that the
91 * initial values are the ones the transport specific code requires */
92static inline void
93scsi_transport_reserve_target(struct scsi_transport_template * t, int space)
94{
95 BUG_ON(t->target_private_offset != 0);
96 t->target_private_offset = ALIGN(t->target_size, sizeof(void *));
97 t->target_size = t->target_private_offset + space;
98}
99static inline void
100scsi_transport_reserve_device(struct scsi_transport_template * t, int space)
101{
102 BUG_ON(t->device_private_offset != 0);
103 t->device_private_offset = ALIGN(t->device_size, sizeof(void *));
104 t->device_size = t->device_private_offset + space;
105}
106static inline void *
107scsi_transport_target_data(struct scsi_target *starget)
108{
109 struct Scsi_Host *shost = dev_to_shost(&starget->dev);
110 return (u8 *)starget->starget_data
111 + shost->transportt->target_private_offset;
112
113}
114static inline void *
115scsi_transport_device_data(struct scsi_device *sdev)
116{
117 struct Scsi_Host *shost = sdev->host;
118 return (u8 *)sdev->sdev_data
119 + shost->transportt->device_private_offset;
120}
121
Linus Torvalds1da177e2005-04-16 15:20:36 -0700122#endif /* SCSI_TRANSPORT_H */