blob: ecb4730d0868504d1ed9d0cb58a3522c38073695 [file] [log] [blame]
Jens Axboe3d6392c2007-07-09 12:38:05 +02001#ifndef BSG_H
2#define BSG_H
3
Douglas Gilbert4ab3b732009-03-09 10:51:38 -04004#include <linux/types.h>
5
FUJITA Tomonori15d10b62007-07-16 08:52:16 +02006#define BSG_PROTOCOL_SCSI 0
7
8#define BSG_SUB_PROTOCOL_SCSI_CMD 0
9#define BSG_SUB_PROTOCOL_SCSI_TMF 1
10#define BSG_SUB_PROTOCOL_SCSI_TRANSPORT 2
11
Boaz Harrosh05378942009-03-24 12:23:40 +010012/*
13 * For flags member below
14 * sg.h sg_io_hdr also has bits defined for it's flags member. However
15 * none of these bits are implemented/used by bsg. The bits below are
16 * allocated to not conflict with sg.h ones anyway.
17 */
18#define BSG_FLAG_Q_AT_TAIL 0x10 /* default, == 0 at this bit, is Q_AT_HEAD */
19
FUJITA Tomonori45977d0e2006-12-20 11:19:32 +010020struct sg_io_v4 {
FUJITA Tomonori38621532006-12-22 09:43:51 +010021 __s32 guard; /* [i] 'Q' to differentiate from v3 */
22 __u32 protocol; /* [i] 0 -> SCSI , .... */
23 __u32 subprotocol; /* [i] 0 -> SCSI command, 1 -> SCSI task
FUJITA Tomonori45977d0e2006-12-20 11:19:32 +010024 management function, .... */
25
FUJITA Tomonori38621532006-12-22 09:43:51 +010026 __u32 request_len; /* [i] in bytes */
27 __u64 request; /* [i], [*i] {SCSI: cdb} */
FUJITA Tomonori0c6a89b2007-07-29 23:00:46 +090028 __u64 request_tag; /* [i] {SCSI: task tag (only if flagged)} */
FUJITA Tomonori38621532006-12-22 09:43:51 +010029 __u32 request_attr; /* [i] {SCSI: task attribute} */
FUJITA Tomonori38621532006-12-22 09:43:51 +010030 __u32 request_priority; /* [i] {SCSI: task priority} */
FUJITA Tomonori0c6a89b2007-07-29 23:00:46 +090031 __u32 request_extra; /* [i] {spare, for padding} */
FUJITA Tomonori38621532006-12-22 09:43:51 +010032 __u32 max_response_len; /* [i] in bytes */
33 __u64 response; /* [i], [*o] {SCSI: (auto)sense data} */
FUJITA Tomonori45977d0e2006-12-20 11:19:32 +010034
FUJITA Tomonori0c6a89b2007-07-29 23:00:46 +090035 /* "dout_": data out (to device); "din_": data in (from device) */
36 __u32 dout_iovec_count; /* [i] 0 -> "flat" dout transfer else
37 dout_xfer points to array of iovec */
FUJITA Tomonori38621532006-12-22 09:43:51 +010038 __u32 dout_xfer_len; /* [i] bytes to be transferred to device */
FUJITA Tomonori0c6a89b2007-07-29 23:00:46 +090039 __u32 din_iovec_count; /* [i] 0 -> "flat" din transfer */
FUJITA Tomonori38621532006-12-22 09:43:51 +010040 __u32 din_xfer_len; /* [i] bytes to be transferred from device */
41 __u64 dout_xferp; /* [i], [*i] */
42 __u64 din_xferp; /* [i], [*o] */
FUJITA Tomonori45977d0e2006-12-20 11:19:32 +010043
FUJITA Tomonori38621532006-12-22 09:43:51 +010044 __u32 timeout; /* [i] units: millisecond */
45 __u32 flags; /* [i] bit mask */
46 __u64 usr_ptr; /* [i->o] unused internally */
47 __u32 spare_in; /* [i] */
FUJITA Tomonori45977d0e2006-12-20 11:19:32 +010048
FUJITA Tomonori38621532006-12-22 09:43:51 +010049 __u32 driver_status; /* [o] 0 -> ok */
50 __u32 transport_status; /* [o] 0 -> ok */
51 __u32 device_status; /* [o] {SCSI: command completion status} */
52 __u32 retry_delay; /* [o] {SCSI: status auxiliary information} */
53 __u32 info; /* [o] additional information */
54 __u32 duration; /* [o] time to complete, in milliseconds */
55 __u32 response_len; /* [o] bytes of response actually written */
FUJITA Tomonori0c6a89b2007-07-29 23:00:46 +090056 __s32 din_resid; /* [o] din_xfer_len - actual_din_xfer_len */
57 __s32 dout_resid; /* [o] dout_xfer_len - actual_dout_xfer_len */
58 __u64 generated_tag; /* [o] {SCSI: transport generated task tag} */
FUJITA Tomonori38621532006-12-22 09:43:51 +010059 __u32 spare_out; /* [o] */
FUJITA Tomonori45977d0e2006-12-20 11:19:32 +010060
FUJITA Tomonori38621532006-12-22 09:43:51 +010061 __u32 padding;
FUJITA Tomonori45977d0e2006-12-20 11:19:32 +010062};
63
64#ifdef __KERNEL__
65
Jens Axboe3d6392c2007-07-09 12:38:05 +020066#if defined(CONFIG_BLK_DEV_BSG)
67struct bsg_class_device {
Tony Jonesee959b02008-02-22 00:13:36 +010068 struct device *class_dev;
FUJITA Tomonori97f46ae2008-04-19 00:43:14 +090069 struct device *parent;
Jens Axboe3d6392c2007-07-09 12:38:05 +020070 int minor;
FUJITA Tomonorid351af02007-07-09 12:40:35 +020071 struct request_queue *queue;
FUJITA Tomonori97f46ae2008-04-19 00:43:14 +090072 struct kref ref;
73 void (*release)(struct device *);
Jens Axboe3d6392c2007-07-09 12:38:05 +020074};
75
FUJITA Tomonori97f46ae2008-04-19 00:43:14 +090076extern int bsg_register_queue(struct request_queue *q,
77 struct device *parent, const char *name,
78 void (*release)(struct device *));
FUJITA Tomonorid351af02007-07-09 12:40:35 +020079extern void bsg_unregister_queue(struct request_queue *);
Jens Axboe3d6392c2007-07-09 12:38:05 +020080#else
FUJITA Tomonori97f46ae2008-04-19 00:43:14 +090081static inline int bsg_register_queue(struct request_queue *q,
82 struct device *parent, const char *name,
83 void (*release)(struct device *))
James Bottomleya4ee0df2007-07-23 09:53:51 -050084{
85 return 0;
86}
FUJITA Tomonori97f46ae2008-04-19 00:43:14 +090087static inline void bsg_unregister_queue(struct request_queue *q)
James Bottomleya4ee0df2007-07-23 09:53:51 -050088{
89}
Jens Axboe3d6392c2007-07-09 12:38:05 +020090#endif
91
FUJITA Tomonori45977d0e2006-12-20 11:19:32 +010092#endif /* __KERNEL__ */
93
Jens Axboe3d6392c2007-07-09 12:38:05 +020094#endif