• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# ScsiPeripheral_Response
2
3
4## Overview
5
6Defines the response structure.
7
8**Since**: 18
9
10**Related module**: [SCSI Peripheral DDK](_s_c_s_i.md)
11
12**Header file**: [scsi_peripheral_types.h](scsi__peripheral__types_8h.md)
13
14
15## Summary
16
17
18### Member Variables
19
20| Name| Description|
21| -------- | -------- |
22| uint8_t [senseData](#sensedata) [[SCSIPERIPHERAL_MAX_SENSE_DATA_LEN](_s_c_s_i.md#scsiperipheral_max_sense_data_len)] | Sense data, that is, information returned by the SCSI device to the host to report the device status, error information, and diagnosis information.|
23| [ScsiPeripheral_Status](_s_c_s_i.md#scsiperipheral_status) [status](#status) | Status when the call is complete, for example, **Good** or **Busy**.|
24| uint8_t [maskedStatus](#maskedstatus) | Masked status, which is used in SCSI Generic (SG) interfaces of Linux to store the processed SCSI status for easy access by applications.|
25| uint8_t [msgStatus](#msgstatus) | Message status.|
26| uint8_t [sbLenWr](#sblenwr) | Number of bytes that are actually written to the sense buffer.|
27| uint16_t [hostStatus](#hoststatus) | Host adapter status, for example, success (0x00), connection failure (0x01), busy bus (0x02), or timeout (0x03).|
28| uint16_t [driverStatus](#driverstatus) | Driver status, for example, success (0x00) or busy device or resource (0x01).|
29| int32_t [resId](#resid) | Length deviation of the actually transmitted data, that is, the number of bytes that are not transmitted.|
30| uint32_t [duration](#duration) | Command execution duration, in ms.|
31
32
33## Member Variable Description
34
35
36### driverStatus
37
38```
39uint16_t ScsiPeripheral_Response::driverStatus
40```
41
42**Description**
43
44Driver status, for example, success (0x00) or busy device or resource (0x01).
45
46
47### duration
48
49```
50uint32_t ScsiPeripheral_Response::duration
51```
52
53**Description**
54
55Command execution duration, in ms.
56
57
58### hostStatus
59
60```
61uint16_t ScsiPeripheral_Response::hostStatus
62```
63
64**Description**
65
66Host adapter status, for example, success (0x00), connection failure (0x01), busy bus (0x02), or timeout (0x03).
67
68
69### maskedStatus
70
71```
72uint8_t ScsiPeripheral_Response::maskedStatus
73```
74
75**Description**
76
77Masked status, which is used in SCSI Generic (SG) interfaces of Linux to store the processed SCSI status for easy access by applications.
78
79
80### msgStatus
81
82```
83uint8_t ScsiPeripheral_Response::msgStatus
84```
85
86**Description**
87
88Message status.
89
90
91### resId
92
93```
94int32_t ScsiPeripheral_Response::resId
95```
96
97**Description**
98
99Length deviation of the actually transmitted data, that is, the number of bytes that are not transmitted.
100
101
102### sbLenWr
103
104```
105uint8_t ScsiPeripheral_Response::sbLenWr
106```
107
108**Description**
109
110Number of bytes that are actually written to the sense buffer.
111
112
113### senseData
114
115```
116uint8_t ScsiPeripheral_Response::senseData[SCSIPERIPHERAL_MAX_SENSE_DATA_LEN]
117```
118
119**Description**
120
121Sense data, that is, information returned by the SCSI device to the host to report the device status, error information, and diagnosis information.
122
123
124### status
125
126```
127ScsiPeripheral_Status ScsiPeripheral_Response::status
128```
129
130**Description**
131
132Status when the call is complete, for example, **Good** or **Busy**.
133