blob: 3f0c64ace4247eae6a13fe80f0e92cc298e51d4c [file] [log] [blame]
Jens Axboe3d6392c2007-07-09 12:38:05 +02001#ifndef BSG_H
2#define BSG_H
3
FUJITA Tomonori15d10b62007-07-16 08:52:16 +02004#define BSG_PROTOCOL_SCSI 0
5
6#define BSG_SUB_PROTOCOL_SCSI_CMD 0
7#define BSG_SUB_PROTOCOL_SCSI_TMF 1
8#define BSG_SUB_PROTOCOL_SCSI_TRANSPORT 2
9
Boaz Harrosh05378942009-03-24 12:23:40 +010010/*
11 * For flags member below
12 * sg.h sg_io_hdr also has bits defined for it's flags member. However
13 * none of these bits are implemented/used by bsg. The bits below are
14 * allocated to not conflict with sg.h ones anyway.
15 */
16#define BSG_FLAG_Q_AT_TAIL 0x10 /* default, == 0 at this bit, is Q_AT_HEAD */
17
FUJITA Tomonori45977d0e2006-12-20 11:19:32 +010018struct sg_io_v4 {
FUJITA Tomonori38621532006-12-22 09:43:51 +010019 __s32 guard; /* [i] 'Q' to differentiate from v3 */
20 __u32 protocol; /* [i] 0 -> SCSI , .... */
21 __u32 subprotocol; /* [i] 0 -> SCSI command, 1 -> SCSI task
FUJITA Tomonori45977d0e2006-12-20 11:19:32 +010022 management function, .... */
23
FUJITA Tomonori38621532006-12-22 09:43:51 +010024 __u32 request_len; /* [i] in bytes */
25 __u64 request; /* [i], [*i] {SCSI: cdb} */
FUJITA Tomonori0c6a89b2007-07-29 23:00:46 +090026 __u64 request_tag; /* [i] {SCSI: task tag (only if flagged)} */
FUJITA Tomonori38621532006-12-22 09:43:51 +010027 __u32 request_attr; /* [i] {SCSI: task attribute} */
FUJITA Tomonori38621532006-12-22 09:43:51 +010028 __u32 request_priority; /* [i] {SCSI: task priority} */
FUJITA Tomonori0c6a89b2007-07-29 23:00:46 +090029 __u32 request_extra; /* [i] {spare, for padding} */
FUJITA Tomonori38621532006-12-22 09:43:51 +010030 __u32 max_response_len; /* [i] in bytes */
31 __u64 response; /* [i], [*o] {SCSI: (auto)sense data} */
FUJITA Tomonori45977d0e2006-12-20 11:19:32 +010032
FUJITA Tomonori0c6a89b2007-07-29 23:00:46 +090033 /* "dout_": data out (to device); "din_": data in (from device) */
34 __u32 dout_iovec_count; /* [i] 0 -> "flat" dout transfer else
35 dout_xfer points to array of iovec */
FUJITA Tomonori38621532006-12-22 09:43:51 +010036 __u32 dout_xfer_len; /* [i] bytes to be transferred to device */
FUJITA Tomonori0c6a89b2007-07-29 23:00:46 +090037 __u32 din_iovec_count; /* [i] 0 -> "flat" din transfer */
FUJITA Tomonori38621532006-12-22 09:43:51 +010038 __u32 din_xfer_len; /* [i] bytes to be transferred from device */
39 __u64 dout_xferp; /* [i], [*i] */
40 __u64 din_xferp; /* [i], [*o] */
FUJITA Tomonori45977d0e2006-12-20 11:19:32 +010041
FUJITA Tomonori38621532006-12-22 09:43:51 +010042 __u32 timeout; /* [i] units: millisecond */
43 __u32 flags; /* [i] bit mask */
44 __u64 usr_ptr; /* [i->o] unused internally */
45 __u32 spare_in; /* [i] */
FUJITA Tomonori45977d0e2006-12-20 11:19:32 +010046
FUJITA Tomonori38621532006-12-22 09:43:51 +010047 __u32 driver_status; /* [o] 0 -> ok */
48 __u32 transport_status; /* [o] 0 -> ok */
49 __u32 device_status; /* [o] {SCSI: command completion status} */
50 __u32 retry_delay; /* [o] {SCSI: status auxiliary information} */
51 __u32 info; /* [o] additional information */
52 __u32 duration; /* [o] time to complete, in milliseconds */
53 __u32 response_len; /* [o] bytes of response actually written */
FUJITA Tomonori0c6a89b2007-07-29 23:00:46 +090054 __s32 din_resid; /* [o] din_xfer_len - actual_din_xfer_len */
55 __s32 dout_resid; /* [o] dout_xfer_len - actual_dout_xfer_len */
56 __u64 generated_tag; /* [o] {SCSI: transport generated task tag} */
FUJITA Tomonori38621532006-12-22 09:43:51 +010057 __u32 spare_out; /* [o] */
FUJITA Tomonori45977d0e2006-12-20 11:19:32 +010058
FUJITA Tomonori38621532006-12-22 09:43:51 +010059 __u32 padding;
FUJITA Tomonori45977d0e2006-12-20 11:19:32 +010060};
61
62#ifdef __KERNEL__
63
Jens Axboe3d6392c2007-07-09 12:38:05 +020064#if defined(CONFIG_BLK_DEV_BSG)
65struct bsg_class_device {
Tony Jonesee959b02008-02-22 00:13:36 +010066 struct device *class_dev;
FUJITA Tomonori97f46ae2008-04-19 00:43:14 +090067 struct device *parent;
Jens Axboe3d6392c2007-07-09 12:38:05 +020068 int minor;
FUJITA Tomonorid351af02007-07-09 12:40:35 +020069 struct request_queue *queue;
FUJITA Tomonori97f46ae2008-04-19 00:43:14 +090070 struct kref ref;
71 void (*release)(struct device *);
Jens Axboe3d6392c2007-07-09 12:38:05 +020072};
73
FUJITA Tomonori97f46ae2008-04-19 00:43:14 +090074extern int bsg_register_queue(struct request_queue *q,
75 struct device *parent, const char *name,
76 void (*release)(struct device *));
FUJITA Tomonorid351af02007-07-09 12:40:35 +020077extern void bsg_unregister_queue(struct request_queue *);
Jens Axboe3d6392c2007-07-09 12:38:05 +020078#else
FUJITA Tomonori97f46ae2008-04-19 00:43:14 +090079static inline int bsg_register_queue(struct request_queue *q,
80 struct device *parent, const char *name,
81 void (*release)(struct device *))
James Bottomleya4ee0df2007-07-23 09:53:51 -050082{
83 return 0;
84}
FUJITA Tomonori97f46ae2008-04-19 00:43:14 +090085static inline void bsg_unregister_queue(struct request_queue *q)
James Bottomleya4ee0df2007-07-23 09:53:51 -050086{
87}
Jens Axboe3d6392c2007-07-09 12:38:05 +020088#endif
89
FUJITA Tomonori45977d0e2006-12-20 11:19:32 +010090#endif /* __KERNEL__ */
91
Jens Axboe3d6392c2007-07-09 12:38:05 +020092#endif