summaryrefslogtreecommitdiff
path: root/components/drivers/virtio/virtio_config/virtio-scsi.h
blob: f0e5320adc32938a64958f0f30f0ebc06c3db3a8 (plain)
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
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
/*
 * Copyright (c) 2006-2023, RT-Thread Development Team
 *
 * SPDX-License-Identifier: Apache-2.0
 *
 * Change Logs:
 * Date           Author       Notes
 * 2023-02-25     GuEe-GUI     the first version
 */

#ifndef __VIRTIO_SCSI_H__
#define __VIRTIO_SCSI_H__

#include <drivers/core/dm.h>

#define VIRTIO_SCSI_CDB_DEFAULT_SIZE   32
#define VIRTIO_SCSI_SENSE_DEFAULT_SIZE 96

#ifndef VIRTIO_SCSI_CDB_SIZE
#define VIRTIO_SCSI_CDB_SIZE VIRTIO_SCSI_CDB_DEFAULT_SIZE
#endif
#ifndef VIRTIO_SCSI_SENSE_SIZE
#define VIRTIO_SCSI_SENSE_SIZE VIRTIO_SCSI_SENSE_DEFAULT_SIZE
#endif

/* SCSI command request, followed by data-out */
rt_packed(struct virtio_scsi_cmd_req
{
    rt_uint8_t lun[8];      /* Logical Unit Number */
    rt_le64_t tag;          /* Command identifier */
    rt_uint8_t task_attr;   /* Task attribute */
    rt_uint8_t prio;        /* SAM command priority field */
    rt_uint8_t crn;
    rt_uint8_t cdb[VIRTIO_SCSI_CDB_SIZE];
});

/* SCSI command request, followed by protection information */
rt_packed(struct virtio_scsi_cmd_req_pi
{
    rt_uint8_t lun[8];      /* Logical Unit Number */
    rt_le64_t tag;          /* Command identifier */
    rt_uint8_t task_attr;   /* Task attribute */
    rt_uint8_t prio;        /* SAM command priority field */
    rt_uint8_t crn;
    rt_le32_t pi_bytesout;  /* DataOUT PI Number of bytes */
    rt_le32_t pi_bytesin;   /* DataIN PI Number of bytes */
    rt_uint8_t cdb[VIRTIO_SCSI_CDB_SIZE];
});

/* Response, followed by sense data and data-in */
rt_packed(struct virtio_scsi_cmd_resp
{
    rt_le32_t sense_len;        /* Sense data length */
    rt_le32_t resid;            /* Residual bytes in data buffer */
    rt_le16_t status_qualifier; /* Status qualifier */
    rt_uint8_t status;          /* Command completion status */
    rt_uint8_t response;        /* Response values */
    rt_uint8_t sense[VIRTIO_SCSI_SENSE_SIZE];
});

/* Task Management Request */
rt_packed(struct virtio_scsi_ctrl_tmf_req
{
    rt_le32_t type;
    rt_le32_t subtype;
    rt_uint8_t lun[8];
    rt_le64_t tag;
});

rt_packed(struct virtio_scsi_ctrl_tmf_resp
{
    rt_uint8_t response;
});

/* Asynchronous notification query/subscription */
rt_packed(struct virtio_scsi_ctrl_an_req
{
    rt_le32_t type;
    rt_uint8_t lun[8];
    rt_le32_t event_requested;
});

rt_packed(struct virtio_scsi_ctrl_an_resp
{
    rt_le32_t event_actual;
    rt_uint8_t response;
});

rt_packed(struct virtio_scsi_event
{
    rt_le32_t event;
    rt_uint8_t lun[8];
    rt_le32_t reason;
});

rt_packed(struct virtio_scsi_config
{
    rt_le32_t num_queues;
    rt_le32_t seg_max;
    rt_le32_t max_sectors;
    rt_le32_t cmd_per_lun;
    rt_le32_t event_info_size;
    rt_le32_t sense_size;
    rt_le32_t cdb_size;
    rt_le16_t max_channel;
    rt_le16_t max_target;
    rt_le32_t max_lun;
});

/* Feature Bits */
#define VIRTIO_SCSI_F_INOUT                    0
#define VIRTIO_SCSI_F_HOTPLUG                  1
#define VIRTIO_SCSI_F_CHANGE                   2
#define VIRTIO_SCSI_F_T10_PI                   3

/* Response codes */
#define VIRTIO_SCSI_S_OK                       0
#define VIRTIO_SCSI_S_OVERRUN                  1
#define VIRTIO_SCSI_S_ABORTED                  2
#define VIRTIO_SCSI_S_BAD_TARGET               3
#define VIRTIO_SCSI_S_RESET                    4
#define VIRTIO_SCSI_S_BUSY                     5
#define VIRTIO_SCSI_S_TRANSPORT_FAILURE        6
#define VIRTIO_SCSI_S_TARGET_FAILURE           7
#define VIRTIO_SCSI_S_NEXUS_FAILURE            8
#define VIRTIO_SCSI_S_FAILURE                  9
#define VIRTIO_SCSI_S_FUNCTION_SUCCEEDED       10
#define VIRTIO_SCSI_S_FUNCTION_REJECTED        11
#define VIRTIO_SCSI_S_INCORRECT_LUN            12

/* Controlq type codes */
#define VIRTIO_SCSI_T_TMF                      0
#define VIRTIO_SCSI_T_AN_QUERY                 1
#define VIRTIO_SCSI_T_AN_SUBSCRIBE             2

/* Valid TMF subtypes */
#define VIRTIO_SCSI_T_TMF_ABORT_TASK           0
#define VIRTIO_SCSI_T_TMF_ABORT_TASK_SET       1
#define VIRTIO_SCSI_T_TMF_CLEAR_ACA            2
#define VIRTIO_SCSI_T_TMF_CLEAR_TASK_SET       3
#define VIRTIO_SCSI_T_TMF_I_T_NEXUS_RESET      4
#define VIRTIO_SCSI_T_TMF_LOGICAL_UNIT_RESET   5
#define VIRTIO_SCSI_T_TMF_QUERY_TASK           6
#define VIRTIO_SCSI_T_TMF_QUERY_TASK_SET       7

/* Events */
#define VIRTIO_SCSI_T_EVENTS_MISSED            0x80000000
#define VIRTIO_SCSI_T_NO_EVENT                 0
#define VIRTIO_SCSI_T_TRANSPORT_RESET          1
#define VIRTIO_SCSI_T_ASYNC_NOTIFY             2
#define VIRTIO_SCSI_T_PARAM_CHANGE             3

/* Reasons of transport reset event */
#define VIRTIO_SCSI_EVT_RESET_HARD             0
#define VIRTIO_SCSI_EVT_RESET_RESCAN           1
#define VIRTIO_SCSI_EVT_RESET_REMOVED          2

#define VIRTIO_SCSI_S_SIMPLE                   0
#define VIRTIO_SCSI_S_ORDERED                  1
#define VIRTIO_SCSI_S_HEAD                     2
#define VIRTIO_SCSI_S_ACA                      3

#endif /* __VIRTIO_SCSI_H__ */