Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1 | /* |
| 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> |
James Bottomley | c3e9dda | 2005-05-24 16:57:31 -0500 | [diff] [blame] | 24 | #include <scsi/scsi_host.h> |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 25 | |
| 26 | struct scsi_transport_template { |
| 27 | /* the attribute containers */ |
| 28 | struct transport_container host_attrs; |
| 29 | struct transport_container target_attrs; |
| 30 | struct transport_container device_attrs; |
| 31 | |
James.Smart@Emulex.Com | 5c44cd2 | 2005-06-10 22:24:30 -0400 | [diff] [blame] | 32 | /* |
Christoph Hellwig | e02f3f5 | 2006-01-13 19:04:00 +0100 | [diff] [blame] | 33 | * If set, called from sysfs and legacy procfs rescanning code. |
James.Smart@Emulex.Com | 5c44cd2 | 2005-06-10 22:24:30 -0400 | [diff] [blame] | 34 | */ |
Christoph Hellwig | e02f3f5 | 2006-01-13 19:04:00 +0100 | [diff] [blame] | 35 | int (*user_scan)(struct Scsi_Host *, uint, uint, uint); |
James.Smart@Emulex.Com | 5c44cd2 | 2005-06-10 22:24:30 -0400 | [diff] [blame] | 36 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 37 | /* The size of the specific transport attribute structure (a |
| 38 | * space of this size will be left at the end of the |
| 39 | * scsi_* structure */ |
| 40 | int device_size; |
James Bottomley | c3e9dda | 2005-05-24 16:57:31 -0500 | [diff] [blame] | 41 | int device_private_offset; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 42 | int target_size; |
James Bottomley | c3e9dda | 2005-05-24 16:57:31 -0500 | [diff] [blame] | 43 | int target_private_offset; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 44 | int host_size; |
James Bottomley | c3e9dda | 2005-05-24 16:57:31 -0500 | [diff] [blame] | 45 | /* no private offset for the host; there's an alternative mechanism */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 46 | |
| 47 | /* |
| 48 | * True if the transport wants to use a host-based work-queue |
| 49 | */ |
| 50 | unsigned int create_work_queue : 1; |
James Smart | c829c39 | 2006-03-13 08:28:57 -0500 | [diff] [blame] | 51 | |
| 52 | /* |
| 53 | * This is an optional routine that allows the transport to become |
| 54 | * involved when a scsi io timer fires. The return value tells the |
| 55 | * timer routine how to finish the io timeout handling: |
| 56 | * EH_HANDLED: I fixed the error, please complete the command |
| 57 | * EH_RESET_TIMER: I need more time, reset the timer and |
| 58 | * begin counting again |
| 59 | * EH_NOT_HANDLED Begin normal error recovery |
| 60 | */ |
| 61 | enum scsi_eh_timer_return (* eh_timed_out)(struct scsi_cmnd *); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 62 | }; |
| 63 | |
| 64 | #define transport_class_to_shost(tc) \ |
| 65 | dev_to_shost((tc)->dev) |
| 66 | |
| 67 | |
James Bottomley | c3e9dda | 2005-05-24 16:57:31 -0500 | [diff] [blame] | 68 | /* Private area maintenance. The driver requested allocations come |
| 69 | * directly after the transport class allocations (if any). The idea |
| 70 | * is that you *must* call these only once. The code assumes that the |
| 71 | * initial values are the ones the transport specific code requires */ |
| 72 | static inline void |
| 73 | scsi_transport_reserve_target(struct scsi_transport_template * t, int space) |
| 74 | { |
| 75 | BUG_ON(t->target_private_offset != 0); |
| 76 | t->target_private_offset = ALIGN(t->target_size, sizeof(void *)); |
| 77 | t->target_size = t->target_private_offset + space; |
| 78 | } |
| 79 | static inline void |
| 80 | scsi_transport_reserve_device(struct scsi_transport_template * t, int space) |
| 81 | { |
| 82 | BUG_ON(t->device_private_offset != 0); |
| 83 | t->device_private_offset = ALIGN(t->device_size, sizeof(void *)); |
| 84 | t->device_size = t->device_private_offset + space; |
| 85 | } |
| 86 | static inline void * |
| 87 | scsi_transport_target_data(struct scsi_target *starget) |
| 88 | { |
| 89 | struct Scsi_Host *shost = dev_to_shost(&starget->dev); |
| 90 | return (u8 *)starget->starget_data |
| 91 | + shost->transportt->target_private_offset; |
| 92 | |
| 93 | } |
| 94 | static inline void * |
| 95 | scsi_transport_device_data(struct scsi_device *sdev) |
| 96 | { |
| 97 | struct Scsi_Host *shost = sdev->host; |
| 98 | return (u8 *)sdev->sdev_data |
| 99 | + shost->transportt->device_private_offset; |
| 100 | } |
| 101 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 102 | #endif /* SCSI_TRANSPORT_H */ |