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
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
|
#ifndef SG_VPD_H
#define SG_VPD_H
/*
* Copyright (c) 2022 Douglas Gilbert.
* All rights reserved.
* Use of this source code is governed by a BSD-style
* license that can be found in the BSD_LICENSE file.
*
* SPDX-License-Identifier: BSD-2-Clause
*/
/* This is a common header file for the sg_inq and sg_vpd utilities */
#include <stdint.h>
#include <stdbool.h>
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif
#include "sg_lib.h"
#include "sg_pr2serr.h"
#ifdef __cplusplus
extern "C" {
#endif
/* standard VPD pages, in ascending page number order */
#define VPD_SUPPORTED_VPDS 0x0
#define VPD_UNIT_SERIAL_NUM 0x80
#define VPD_IMP_OP_DEF 0x81 /* obsolete in SPC-2 */
#define VPD_ASCII_OP_DEF 0x82 /* obsolete in SPC-2 */
#define VPD_DEVICE_ID 0x83
#define VPD_SOFTW_INF_ID 0x84
#define VPD_MAN_NET_ADDR 0x85
#define VPD_EXT_INQ 0x86 /* Extended Inquiry */
#define VPD_MODE_PG_POLICY 0x87
#define VPD_SCSI_PORTS 0x88
#define VPD_ATA_INFO 0x89
#define VPD_POWER_CONDITION 0x8a
#define VPD_DEVICE_CONSTITUENTS 0x8b
#define VPD_CFA_PROFILE_INFO 0x8c
#define VPD_POWER_CONSUMPTION 0x8d
#define VPD_3PARTY_COPY 0x8f /* 3PC, XCOPY, SPC-4, SBC-3 */
#define VPD_PROTO_LU 0x90
#define VPD_PROTO_PORT 0x91
#define VPD_SCSI_FEATURE_SETS 0x92 /* spc5r11 */
#define VPD_BLOCK_LIMITS 0xb0 /* SBC-3 */
#define VPD_SA_DEV_CAP 0xb0 /* SSC-3 */
#define VPD_OSD_INFO 0xb0 /* OSD */
#define VPD_BLOCK_DEV_CHARS 0xb1 /* SBC-3 */
#define VPD_MAN_ASS_SN 0xb1 /* SSC-3, ADC-2 */
#define VPD_SECURITY_TOKEN 0xb1 /* OSD */
#define VPD_TA_SUPPORTED 0xb2 /* SSC-3 */
#define VPD_LB_PROVISIONING 0xb2 /* SBC-3 */
#define VPD_REFERRALS 0xb3 /* SBC-3 */
#define VPD_AUTOMATION_DEV_SN 0xb3 /* SSC-3 */
#define VPD_SUP_BLOCK_LENS 0xb4 /* sbc4r01 */
#define VPD_DTDE_ADDRESS 0xb4 /* SSC-4 */
#define VPD_BLOCK_DEV_C_EXTENS 0xb5 /* sbc4r02 */
#define VPD_LB_PROTECTION 0xb5 /* SSC-5 */
#define VPD_ZBC_DEV_CHARS 0xb6 /* zbc-r01b */
#define VPD_BLOCK_LIMITS_EXT 0xb7 /* sbc4r08 */
#define VPD_FORMAT_PRESETS 0xb8 /* sbc4r18 */
#define VPD_CON_POS_RANGE 0xb9 /* sbc5r01 */
#define VPD_NOPE_WANT_STD_INQ -2 /* request for standard inquiry */
enum sg_vpd_invoker_e {
SG_VPD_INV_NONE = 0,
SG_VPD_INV_SG_INQ,
SG_VPD_INV_SG_VPD,
};
/* This structure holds the union of options available in sg_inq and sg_vpd */
struct opts_t {
enum sg_vpd_invoker_e invoker; /* indicates if for sg_inq or sg_vpd */
bool do_all; /* sg_vpd */
bool do_ata; /* sg_inq */
bool do_decode; /* sg_inq */
bool do_descriptors; /* sg_inq */
bool do_enum; /* sg_enum */
bool do_export; /* sg_inq */
bool do_force; /* sg_inq + sg_vpd */
bool do_only; /* sg_inq: --only after stdinq: don't fetch VPD page 0x80 */
bool do_quiet; /* sg_vpd */
bool page_given; /* sg_inq + sg_vpd */
bool possible_nvme; /* sg_inq */
bool verbose_given; /* sg_inq + sg_vpd */
bool version_given; /* sg_inq + sg_vpd */
bool do_vpd; /* sg_inq */
bool std_inq_a_valid; /* sg_inq + sg_vpd */
#ifdef SG_SCSI_STRINGS
bool opt_new; /* sg_inq */
#endif
int do_block; /* do_block */
int do_cmddt; /* sg_inq */
int do_help; /* sg_inq */
int do_hex; /* sg_inq + sg_vpd */
int do_ident; /* sg_vpd */
int do_long; /* sg_inq[int] + sg_vpd[bool] */
int do_raw; /* sg_inq + sg_vpd */
int do_vendor; /* sg_inq */
int examine; /* sg_vpd */
int maxlen; /* sg_inq[was: resp_len] + sg_vpd */
int num_pages; /* sg_inq */
int page_pdt; /* sg_inq */
int vend_prod_num; /* sg_vpd */
int verbose; /* sg_inq + sg_vpd */
int vpd_pn; /* sg_vpd */
const char * device_name; /* sg_inq + sg_vpd */
const char * page_str; /* sg_inq + sg_vpd */
const char * inhex_fn; /* sg_inq + sg_vpd */
const char * sinq_inraw_fn; /* sg_inq + sg_vpd */
const char * vend_prod; /* sg_vpd */
sgj_state json_st;
uint8_t std_inq_a[36];
};
struct svpd_values_name_t {
int value; /* VPD page number */
int subvalue; /* to differentiate if value+pdt are not unique */
int pdt; /* peripheral device type id, -1 is the default */
/* (all or not applicable) value */
const char * acron;
const char * name;
};
typedef int (*recurse_vpd_decodep)(struct opts_t *, sgj_opaque_p jop, int off);
sgj_opaque_p sg_vpd_js_hdr(sgj_state * jsp, sgj_opaque_p jop,
const char * name, const uint8_t * vpd_hdrp);
void decode_net_man_vpd(uint8_t * buff, int len, struct opts_t * op,
sgj_opaque_p jap);
void decode_x_inq_vpd(uint8_t * b, int len, bool protect, struct opts_t * op,
sgj_opaque_p jop);
void decode_softw_inf_id(uint8_t * buff, int len, struct opts_t * op,
sgj_opaque_p jap);
void decode_mode_policy_vpd(uint8_t * buff, int len, struct opts_t * op,
sgj_opaque_p jap);
void decode_power_condition(uint8_t * buff, int len, struct opts_t * op,
sgj_opaque_p jop);
int filter_json_dev_ids(uint8_t * buff, int len, int m_assoc,
struct opts_t * op, sgj_opaque_p jap);
void decode_ata_info_vpd(const uint8_t * buff, int len, struct opts_t * op,
sgj_opaque_p jop);
void decode_feature_sets_vpd(uint8_t * buff, int len, struct opts_t * op,
sgj_opaque_p jap);
void decode_dev_constit_vpd(const uint8_t * buff, int len,
struct opts_t * op, sgj_opaque_p jap,
recurse_vpd_decodep fp);
sgj_opaque_p std_inq_decode_js(const uint8_t * b, int len,
struct opts_t * op, sgj_opaque_p jop);
void decode_power_consumption(uint8_t * buff, int len,
struct opts_t * op, sgj_opaque_p jap);
void decode_block_limits_vpd(const uint8_t * buff, int len,
struct opts_t * op, sgj_opaque_p jop);
void decode_block_dev_ch_vpd(const uint8_t * buff, int len,
struct opts_t * op, sgj_opaque_p jop);
int decode_block_lb_prov_vpd(uint8_t * buff, int len,
struct opts_t * op, sgj_opaque_p jop);
void decode_referrals_vpd(uint8_t * buff, int len, struct opts_t * op,
sgj_opaque_p jop);
void decode_sup_block_lens_vpd(uint8_t * buff, int len, struct opts_t * op,
sgj_opaque_p jap);
void decode_block_dev_char_ext_vpd(uint8_t * buff, int len,
struct opts_t * op, sgj_opaque_p jop);
void decode_zbdch_vpd(uint8_t * buff, int len, struct opts_t * op,
sgj_opaque_p jop);
void decode_block_limits_ext_vpd(uint8_t * buff, int len, struct opts_t * op,
sgj_opaque_p jop);
void decode_format_presets_vpd(uint8_t * buff, int len, struct opts_t * op,
sgj_opaque_p jap);
const char * pqual_str(int pqual);
void svpd_enumerate_vendor(int vend_prod_num);
int svpd_count_vendor_vpds(int vpd_pn, int vend_prod_num);
int svpd_decode_vendor(int sg_fd, struct opts_t * op, int off);
const struct svpd_values_name_t * svpd_find_vendor_by_acron(const char * ap);
int svpd_find_vp_num_by_acron(const char * vp_ap);
const struct svpd_values_name_t * svpd_find_vendor_by_num(int page_num,
int vend_prod_num);
int vpd_fetch_page(int sg_fd, uint8_t * rp, int page, int mxlen,
bool qt, int vb, int * rlenp);
void dup_sanity_chk(int sz_opts_t, int sz_values_name_t);
extern uint8_t * rsp_buff;
extern const char * t10_vendor_id_hr;
extern const char * t10_vendor_id_js;
extern const char * product_id_hr;
extern const char * product_id_js;
extern const char * product_rev_lev_hr;
extern const char * product_rev_lev_js;
#ifdef __cplusplus
}
#endif
#endif /* end of SG_VPD_H */
|
