aboutsummaryrefslogtreecommitdiff
path: root/src/sg_modes.c
blob: 0be40ee4a201639d85341d4ff6585af3d3d6a062 (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
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
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
/*
 *  Copyright (C) 2000-2022 D. Gilbert
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2, or (at your option)
 *  any later version.
 *
 * SPDX-License-Identifier: GPL-2.0-or-later
 *
 *  This program outputs information provided by a SCSI MODE SENSE command.
 *  Does 10 byte MODE SENSE commands by default, Trent Piepho added a "-6"
 *  switch for force 6 byte mode sense commands.
 *  This utility cannot modify mode pages. See the sdparm utility for that.
 */

#include <unistd.h>
#include <fcntl.h>
#include <stdio.h>
#include <stdlib.h>
#include <stdarg.h>
#include <stdbool.h>
#include <string.h>
#include <ctype.h>
#include <errno.h>
#include <getopt.h>

#ifdef HAVE_CONFIG_H
#include "config.h"
#endif
#include "sg_lib.h"
#include "sg_cmds_basic.h"
#include "sg_unaligned.h"
#include "sg_pr2serr.h"

static const char * version_str = "1.75 20220202";

#define DEF_ALLOC_LEN (1024 * 4)
#define DEF_6_ALLOC_LEN 252
#define UNLIKELY_ABOVE_LEN 512
#define PG_CODE_ALL 0x3f
#define PG_CODE_MASK 0x3f
#define PG_CODE_MAX 0x3f
#define SPG_CODE_ALL 0xff
#define PROTO_SPECIFIC_1 0x18
#define PROTO_SPECIFIC_2 0x19

#define EBUFF_SZ 256


struct opts_t {
    bool do_dbd;
    bool do_dbout;
    bool do_examine;
    bool do_flexible;
    bool do_list;
    bool do_llbaa;
    bool do_six;
    bool o_readwrite;
    bool subpg_code_given;
    bool opt_new;
    bool verbose_given;
    bool version_given;
    int do_all;
    int do_help;
    int do_hex;
    int maxlen;
    int do_raw;
    int verbose;
    int page_control;
    int pg_code;
    int subpg_code;
    const char * device_name;
    const char * page_acron;
};

struct page_code_desc {
    int page_code;
    int subpage_code;
    const char * acron;
    const char * desc;
};

struct pc_desc_group {
    struct page_code_desc * pcdp;
    const char * group_name;
};

static struct option long_options[] = {
        {"all", no_argument, 0, 'a'},
        {"control", required_argument, 0, 'c'},
        {"dbd", no_argument, 0, 'd'},
        {"dbout", no_argument, 0, 'D'},
        {"examine", no_argument, 0, 'e'},
        {"flexible", no_argument, 0, 'f'},
        {"help", no_argument, 0, 'h'},
        {"hex", no_argument, 0, 'H'},
        {"list", no_argument, 0, 'l'},
        {"llbaa", no_argument, 0, 'L'},
        {"maxlen", required_argument, 0, 'm'},
        {"new", no_argument, 0, 'N'},
        {"old", no_argument, 0, 'O'},
        {"page", required_argument, 0, 'p'},
        {"raw", no_argument, 0, 'r'},
        {"read-write", no_argument, 0, 'w'},
        {"read_write", no_argument, 0, 'w'},
        {"readwrite", no_argument, 0, 'w'},
        {"six", no_argument, 0, '6'},
        {"verbose", no_argument, 0, 'v'},
        {"version", no_argument, 0, 'V'},
        {0, 0, 0, 0},
};

/* Common to all SCSI devices (found in SPCx). In numerical order */
static struct page_code_desc pc_desc_common[] = {
    {0x0, 0x0, "ua", "Unit Attention condition [vendor specific format]"},
    {0x2, 0x0, "dr", "Disconnect-Reconnect"},
    {0x9, 0x0, "pd", "Peripheral device (obsolete)"},
    {0xa, 0x0, "co", "Control"},
    {0xa, 0x1, "coe", "Control extension"},
    {0xa, 0x3, "cdla", "Command duration limit A"},
    {0xa, 0x4, "cdlb", "Command duration limit B"},
    {0xa, 0x7, "cdt2a", "Command duration limit T2A"},  /* spc6r01 */
    {0xa, 0x8, "cdt2b", "Command duration limit T2B"},  /* spc6r01 */
    {0x15, 0x0, "ext_", "Extended"},
    {0x16, 0x0, "edts", "Extended device-type specific"},
    {0x18, 0x0, "pslu", "Protocol specific lu"},
    {0x19, 0x0, "pspo", "Protocol specific port"},
    {0x1a, 0x0, "po", "Power condition"},
    {0x1a, 0x1, "ps", "Power consumption"},
    {0x1c, 0x0, "ie", "Informational exceptions control"},
    {PG_CODE_ALL, 0x0, "asmp", "[yields all supported pages]"},
    {PG_CODE_ALL, SPG_CODE_ALL,"asmsp",
        "[yields all supported pages and subpages]"},
    {0x0, 0x0, NULL, NULL},
};

static struct page_code_desc pc_desc_disk[] = {
    {0x1, 0x0, "rw", "Read-Write error recovery"},
    {0x3, 0x0, "fo", "Format (obsolete)"},
    {0x4, 0x0, "rd", "Rigid disk geometry (obsolete)"},
    {0x5, 0x0, "fd", "Flexible disk (obsolete)"},
    {0x7, 0x0, "ve", "Verify error recovery"},
    {0x8, 0x0, "ca", "Caching"},
    {0xa, 0x2, "atag", "Application tag"},
    {0xa, 0x5, "ioad", "IO advice hints grouping"}, /* added sbc4r06 */
    {0xa, 0x6, "bop", "Background operation control"}, /* added sbc4r07 */
    {0xa, 0xf1, "pat", "Parallel ATA control (SAT)"},
    {0xa, 0xf2, "afc", "ATA feature control (SAT)"},   /* added 20-085r2 */
    {0xb, 0x0, "mts", "Medium types supported (obsolete)"},
    {0xc, 0x0, "not", "Notch and partition (obsolete)"},
    {0xd, 0x0, "pco", "Power condition (obsolete, moved to 0x1a)"},
    {0x10, 0x0, "xo", "XOR control"}, /* obsolete in sbc3r32 */
    {0x1a, 0xf1, "apo", "ATA Power condition"},
    {0x1c, 0x1, "bc", "Background control"},
    {0x1c, 0x2, "lbp", "Logical block provisioning"},
    {0x0, 0x0, NULL, NULL},
};

static struct page_code_desc pc_desc_tape[] = {
    {0x1, 0x0, "rw", "Read-Write error recovery"},
    {0xa, 0xf0, "cdp", "Control data protection"},
    {0xf, 0x0, "dac", "Data Compression"},
    {0x10, 0x0, "dc", "Device configuration"},
    {0x10, 0x1, "dcs", "Device configuration extension"},
    {0x11, 0x0, "mpa", "Medium Partition [1]"},
    {0x12, 0x0, "mpa2", "Medium Partition [2]"},
    {0x13, 0x0, "mpa3", "Medium Partition [3]"},
    {0x14, 0x0, "mpar", "Medium Partition [4]"},
    {0x1c, 0x0, "ie", "Informational exceptions control (tape version)"},
    {0x1d, 0x0, "mco", "Medium configuration"},
    {0x0, 0x0, NULL, NULL},
};

static struct page_code_desc pc_desc_cddvd[] = {
    {0x1, 0x0, "rw", "Read-Write error recovery"},
    {0x3, 0x0, "mrw", "Mount Rainer rewritable"},
    {0x5, 0x0, "wp", "Write parameters"},
    {0x7, 0x0, "ve", "Verify error recovery"},
    {0x8, 0x0, "ca", "Caching"},
    {0xd, 0x0, "cddp", "CD device parameters (obsolete)"},
    {0xe, 0x0, "cda", "CD audio"},
    {0x1a, 0x0, "po", "Power condition (mmc)"},
    {0x1c, 0x0, "ffrc", "Fault/failure reporting control (mmc)"},
    {0x1d, 0x0, "tp", "Timeout and protect"},
    {0x2a, 0x0, "cms", "MM capabilities and mechanical status (obsolete)"},
    {0x0, 0x0, NULL, NULL},
};

static struct page_code_desc pc_desc_smc[] = {
    {0x1d, 0x0, "eaa", "Element address assignment"},
    {0x1e, 0x0, "tgp", "Transport geometry parameters"},
    {0x1f, 0x0, "dcs", "Device capabilities"},
    {0x1f, 0x41, "edc", "Extended device capabilities"},
    {0x0, 0x0, NULL, NULL},
};

static struct page_code_desc pc_desc_scc[] = {
    {0x1b, 0x0, "sslm", "LUN mapping"},
    {0x0, 0x0, NULL, NULL},
};

static struct page_code_desc pc_desc_ses[] = {
    {0x14, 0x0, "esm", "Enclosure services management"},
    {0x0, 0x0, NULL, NULL},
};

static struct page_code_desc pc_desc_rbc[] = {
    {0x6, 0x0, "rbc", "RBC device parameters"},
    {0x0, 0x0, NULL, NULL},
};

static struct page_code_desc pc_desc_adc[] = {
    /* {0xe, 0x0, "ADC device configuration"}, */
    {0xe, 0x1, "adtd", "Target device"},
    {0xe, 0x2, "addp", "DT device primary port"},
    {0xe, 0x3, "adlu", "Logical unit"},
    {0xe, 0x4, "adts", "Target device serial number"},
    {0x0, 0x0, NULL, NULL},
};


/* Transport reated mode pages */
static struct page_code_desc pc_desc_t_fcp[] = {
    {0x18, 0x0, "pl", "LU control"},
    {0x19, 0x0, "pp", "Port control"},
    {0x0, 0x0, NULL, NULL},
};

static struct page_code_desc pc_desc_t_spi4[] = {
    {0x18, 0x0, "luc", "LU control"},
    {0x19, 0x0, "pp", "Port control short format"},
    {0x19, 0x1, "mc", "Margin control"},
    {0x19, 0x2, "stc", "Saved training configuration value"},
    {0x19, 0x3, "ns", "Negotiated settings"},
    {0x19, 0x4, "rtc", "Report transfer capabilities"},
    {0x0, 0x0, NULL, NULL},
};

/* SAS protocol layers now in SPL standards */
static struct page_code_desc pc_desc_t_sas[] = {
    {0x18, 0x0, "pslu", "Protocol specific logical unit (SPL)"},
    {0x19, 0x0, "pspo", "Protocol specific port (SPL)"},
    {0x19, 0x1, "pcd", "Phy control and discover (SPL)"},
    {0x19, 0x2, "spc", "Shared port control (SPL)"},
    {0x19, 0x3, "sep", "Enhanced phy control (SPL)"},
    {0x19, 0x4, "oobm", "Out of band management control (SPL)"}, /* spl5r01 */
    {0x0, 0x0, NULL, NULL},
};

static struct page_code_desc pc_desc_t_adc[] = {
    {0xe, 0x1, "addt", "Target device"},
    {0xe, 0x2, "addp", "DT device primary port"},
    {0xe, 0x3, "adlu", "Logical unit"},
    {0x18, 0x0, "pslu", "Protocol specific lu"},
    {0x19, 0x0, "pspo", "Protocol specific port"},
    {0x0, 0x0, NULL, NULL},
};

static struct page_code_desc pc_desc_zbc[] = {
    {0x1, 0x0, "rw", "Read-Write error recovery"},
    {0x7, 0x0, "ve", "Verify error recovery"},
    {0x8, 0x0, "ca", "Caching"},
    {0xa, 0x2, "atag", "Application tag"},
    {0xa, 0xf, "zbdct", "Zoned block device control"},  /* zbc2r04a */
    {0x1c, 0x1, "bc", "Background control"},
    {0x0, 0x0, NULL, NULL},
};

struct pc_desc_group pcd_gr_arr[] = {
    {pc_desc_common, "common"},
    {pc_desc_disk, "disk"},
    {pc_desc_tape, "tape"},
    {pc_desc_cddvd, "cd/dvd"},
    {pc_desc_smc, "media changer"},
    {pc_desc_scc, "scsi controller"},
    {pc_desc_ses, "enclosure"},
    {pc_desc_rbc, "reduced block"},
    {pc_desc_adc, "adc"},
    {pc_desc_zbc, "zbc"},
    {pc_desc_t_fcp, "transport: FCP"},
    {pc_desc_t_spi4, "transport: SPI"},
    {pc_desc_t_sas, "transport: SAS"},
    {pc_desc_t_adc, "transport: ADC"},

    {NULL, NULL},
};



static void
usage()
{
    printf("Usage: sg_modes [--all] [--control=PC] [--dbd] [--dbout] "
           "[--examine]\n"
           "                [--flexible] [--help] [--hex] [--list] "
           "[--llbaa]\n"
           "                [--maxlen=LEN] [--page=PG[,SPG]] [--raw] [-R] "
           "[--readwrite]\n"
           "                [--six] [--verbose] [--version] [DEVICE]\n"
           "  where:\n"
           "    --all|-a        get all mode pages supported by device\n"
           "                    use twice to get all mode pages and subpages\n"
           "    --control=PC|-c PC    page control (default: 0)\n"
           "                       0: current, 1: changeable,\n"
           "                       2: (manufacturer's) defaults, 3: saved\n"
           "    --dbd|-d        disable block descriptors (DBD field in cdb)\n"
           "    --dbout|-D      disable block descriptor output\n"
           "    --examine|-e    examine pages # 0 through to 0x3e, note if "
           "found\n"
           "    --flexible|-f    be flexible, cope with MODE SENSE 6/10 "
           "response mixup\n");
    printf("    --help|-h       print usage message then exit\n"
           "    --hex|-H        output full response in hex\n"
           "                    use twice to output page number and header "
           "in hex\n"
           "    --list|-l       list common page codes for device peripheral "
           "type,\n"
           "                    if no device given then assume disk type\n"
           "    --llbaa|-L      set Long LBA Accepted (LLBAA field in mode "
           "sense (10) cdb)\n"
           "    --maxlen=LEN|-m LEN    max response length (allocation "
           "length in cdb)\n"
           "                           (def: 0 -> 4096 or 252 (for MODE "
           "SENSE 6) bytes)\n"
           "    --page=PG|-p PG    page code to fetch (def: 63). May be "
           "acronym\n"
           "    --page=PG,SPG|-p PG,SPG\n"
           "                       page code and subpage code to fetch "
           "(defs: 63,0)\n"
           "    --raw|-r        output response in binary to stdout\n"
           "    -R              mode page response to stdout, a byte per "
           "line in ASCII\n"
           "                    hex (same result as '--raw --raw')\n"
           "    --readwrite|-w    open DEVICE read-write (def: open "
           "read-only)\n"
           "    --six|-6|-s     use MODE SENSE(6), by default uses MODE "
           "SENSE(10)\n"
           "    --verbose|-v    increase verbosity\n"
           "    --old|-O        use old interface (use as first option)\n"
           "    --version|-V    output version string then exit\n\n"
           "Performs a SCSI MODE SENSE (10 or 6) command. To access and "
           "possibly change\nmode page fields see the sdparm utility.\n");
}

static void
usage_old()
{
    printf("Usage:  sg_modes [-a] [-A] [-c=PC] [-d] [-D] [-e] [-f] [-h] "
           "[-H] [-l] [-L]\n"
           "                 [-m=LEN] [-p=PG[,SPG]] [-r] [-subp=SPG] [-v] "
           "[-V] [-6]\n"
           "                 [DEVICE]\n"
           " where:\n"
           "   -a    get all mode pages supported by device\n"
           "   -A    get all mode pages and subpages supported by device\n"
           "   -c=PC    page control (def: 0 [current],"
           " 1 [changeable],\n"
           "                               2 [default], 3 [saved])\n"
           "   -d    disable block descriptors (DBD field in cdb)\n"
           "   -D    disable block descriptor output\n"
           "   -e    examine pages # 0 through to 0x3e, note if found\n"
           "   -f    be flexible, cope with MODE SENSE 6/10 response "
           "mixup\n");
    printf("   -h    output page number and header in hex\n"
           "   -H    output page number and header in hex (same as '-h')\n"
           "   -l    list common page codes for device peripheral type,\n"
           "         if no device given then assume disk type\n"
           "   -L    set Long LBA Accepted (LLBAA field in mode sense "
           "10 cdb)\n"
           "   -m=LEN    max response length (allocation length in cdb)\n"
           "             (def: 0 -> 4096 or 252 (for MODE SENSE 6) bytes)\n"
           "   -p=PG     page code in hex (def: 3f). No acronym allowed\n"
           "   -p=PG,SPG    both in hex, (defs: 3f,0)\n"
           "   -r    mode page output to stdout, a byte per line in "
           "ASCII hex\n"
           "   -subp=SPG    sub page code in hex (def: 0)\n"
           "   -v    verbose\n"
           "   -V    output version string\n"
           "   -6    Use MODE SENSE(6), by default uses MODE SENSE(10)\n"
           "   -N|--new     use new interface\n"
           "   -?    output this usage message\n\n"
           "Performs a SCSI MODE SENSE (10 or 6) command\n");
}

static void
enum_pc_desc(void)
{
    bool first = true;
    const struct pc_desc_group * pcd_grp = pcd_gr_arr;
    char b[128];

    for ( ; pcd_grp->pcdp; ++pcd_grp) {
        const struct page_code_desc * pcdp = pcd_grp->pcdp;

        if (first)
            first = false;
        else
            printf("\n");
        printf("Mode pages group: %s:\n", pcd_grp->group_name);
        for ( ; pcdp->acron; ++pcdp) {
            if (pcdp->subpage_code > 0)
                snprintf(b, sizeof(b), "[0x%x,0x%x]", pcdp->page_code,
                         pcdp->subpage_code);
            else
                snprintf(b, sizeof(b), "[0x%x]", pcdp->page_code);
            printf("  %s: %s  %s\n", pcdp->acron, pcdp->desc, b);
        }
    }
}

static const struct page_code_desc *
find_pc_desc(const char * acron)
{
    const struct pc_desc_group * pcd_grp = pcd_gr_arr;

    for ( ; pcd_grp->pcdp; ++pcd_grp) {
        const struct page_code_desc * pcdp = pcd_grp->pcdp;

        for ( ; pcdp->acron; ++pcdp) {
            if (0 == strcmp(acron, pcdp->acron))
                return pcdp;
        }
    }
    return NULL;
}

static void
usage_for(const struct opts_t * op)
{
    if (op->opt_new)
        usage();
    else
        usage_old();
}

/* Processes command line options according to new option format. Returns
 * 0 is ok, else SG_LIB_SYNTAX_ERROR is returned. */
static int
new_parse_cmd_line(struct opts_t * op, int argc, char * argv[])
{
    int c, n, nn;
    char * cp;

    while (1) {
        int option_index = 0;

        c = getopt_long(argc, argv, "6aAc:dDefhHlLm:NOp:rRsvV", long_options,
                        &option_index);
        if (c == -1)
            break;

        switch (c) {
        case '6':
            op->do_six = true;
            break;
        case 'a':
            ++op->do_all;
            break;
        case 'A':
            op->do_all += 2;
            break;
        case 'c':
            n = sg_get_num(optarg);
            if ((n < 0) || (n > 3)) {
                pr2serr("bad argument to '--control='\n");
                usage();
                return SG_LIB_SYNTAX_ERROR;
            }
            op->page_control = n;
            break;
        case 'd':
            op->do_dbd = true;
            break;
        case 'D':
            op->do_dbout = true;
            break;
        case 'e':
            op->do_examine = true;
            break;
        case 'f':
            op->do_flexible = true;
            break;
        case 'h':
        case '?':
            ++op->do_help;
            break;
        case 'H':
            ++op->do_hex;
            break;
        case 'l':
            op->do_list = true;
            break;
        case 'L':
            op->do_llbaa = true;
            break;
        case 'm':
            n = sg_get_num(optarg);
            if ((n < 0) || (n > 65535)) {
                pr2serr("bad argument to '--maxlen='\n");
                usage();
                return SG_LIB_SYNTAX_ERROR;
            }
            if ((n > 0) && (n < 4)) {
                pr2serr("Changing that '--maxlen=' value to 4\n");
                n = 4;
            }
            op->maxlen = n;
            break;
        case 'N':
            break;      /* ignore */
        case 'O':
            op->opt_new = false;
            return 0;
        case 'p':
            if (isalpha((uint8_t)optarg[0])) {
                const struct page_code_desc * pcdp;

                op->page_acron = optarg;
                if (0 == memcmp("xxx", optarg, 3)) {
                    enum_pc_desc();
                    return SG_LIB_OK_FALSE;     /* for quick exit */
                }
                pcdp = find_pc_desc(optarg);
                if (pcdp) {
                    if (pcdp->subpage_code > 0) {
                        op->subpg_code = pcdp->subpage_code;
                        op->subpg_code_given = true;
                    }
                    op->pg_code = pcdp->page_code;
                } else {
                    pr2serr(" Couldn't match acronym '%s', try '-p xxx' for "
                            "list\n", optarg);
                    return SG_LIB_SYNTAX_ERROR;
                }
            } else {
                cp = strchr(optarg, ',');
                n = sg_get_num_nomult(optarg);
                if ((n < 0) || (n > 63)) {
                    pr2serr("Bad argument to '--page='\n");
                    usage();
                    return SG_LIB_SYNTAX_ERROR;
                }
                if (cp) {
                    nn = sg_get_num_nomult(cp + 1);
                    if ((nn < 0) || (nn > 255)) {
                        pr2serr("Bad second value in argument to "
                                "'--page='\n");
                        usage();
                        return SG_LIB_SYNTAX_ERROR;
                    }
                    op->subpg_code = nn;
                    op->subpg_code_given = true;
                }
                op->pg_code = n;
            }
            break;
        case 'r':
            ++op->do_raw;
            break;
        case 'R':
            op->do_raw += 2;
            break;
        case 's':
            op->do_six = true;
            break;
        case 'v':
            op->verbose_given = true;
            ++op->verbose;
            break;
        case 'V':
            op->version_given = true;
            break;
        case 'w':
            op->o_readwrite = true;
            break;
        default:
            pr2serr("unrecognised option code %c [0x%x]\n", c, c);
            if (op->do_help)
                break;
            usage();
            return SG_LIB_SYNTAX_ERROR;
        }
    }
    if (optind < argc) {
        if (NULL == op->device_name) {
            op->device_name = argv[optind];
            ++optind;
        }
        if (optind < argc) {
            for (; optind < argc; ++optind)
                pr2serr("Unexpected extra argument: %s\n",
                        argv[optind]);
            usage();
            return SG_LIB_SYNTAX_ERROR;
        }
    }
    return 0;
}

/* Processes command line options according to old option format. Returns
 * 0 is ok, else SG_LIB_SYNTAX_ERROR is returned. */
static int
old_parse_cmd_line(struct opts_t * op, int argc, char * argv[])
{
    bool jmp_out;
    int k, plen, num, n;
    char pc1;
    unsigned int u, uu;
    const char * cp;

    for (k = 1; k < argc; ++k) {
        cp = argv[k];
        plen = strlen(cp);
        if (plen <= 0)
            continue;
        if ('-' == *cp) {
            for (--plen, ++cp, jmp_out = false; plen > 0; --plen, ++cp) {
                switch (*cp) {
                case '6':
                    op->do_six = true;
                    break;
                case 'a':
                    ++op->do_all;
                    break;
                case 'A':
                    op->do_all += 2;
                    break;
                case 'd':
                    op->do_dbd = true;
                    break;
                case 'D':
                    op->do_dbout = true;
                    break;
                case 'e':
                    op->do_examine = true;
                    break;
                case 'f':
                    op->do_flexible = true;
                    break;
                case 'h':
                case 'H':
                    op->do_hex += 2;
                    break;
                case 'l':
                    op->do_list = true;
                    break;
                case 'L':
                    op->do_llbaa = true;
                    break;
                case 'N':
                    op->opt_new = true;
                    return 0;
                case 'O':
                    break;
                case 'r':
                    op->do_raw += 2;
                    break;
                case 'v':
                    op->verbose_given = true;
                    ++op->verbose;
                    break;
                case 'V':
                    op->version_given = true;
                    break;
                case '?':
                    ++op->do_help;
                    break;
                default:
                    jmp_out = true;
                    break;
                }
                if (jmp_out)
                    break;
            }
            if (plen <= 0)
                continue;
            if (0 == strncmp("c=", cp, 2)) {
                num = sscanf(cp + 2, "%x", &u);
                if ((1 != num) || (u > 3)) {
                    pr2serr("Bad page control after 'c=' option\n");
                    usage_old();
                    return SG_LIB_SYNTAX_ERROR;
                }
                op->page_control = u;
            } else if (0 == strncmp("m=", cp, 2)) {
                num = sscanf(cp + 2, "%d", &n);
                if ((1 != num) || (n < 0) || (n > 65535)) {
                    pr2serr("Bad argument after 'm=' option\n");
                    usage_old();
                    return SG_LIB_SYNTAX_ERROR;
                }
                if ((n > 0) && (n < 4)) {
                    pr2serr("Changing that '-m=' value to 4\n");
                    n = 4;
                }
                op->maxlen = n;
            } else if (0 == strncmp("p=", cp, 2)) {
                pc1 = *(cp + 2);
                if (isalpha(pc1) && ((islower(pc1) && (pc1 > 'f')) ||
                                     (isupper(pc1) && (pc1 > 'F')))) {
                    pr2serr("Old format doesn't accept mode page acronyms: "
                            "%s\n", cp + 2);
                    return SG_LIB_SYNTAX_ERROR;
                }
                if (NULL == strchr(cp + 2, ',')) {
                    num = sscanf(cp + 2, "%x", &u);
                    if ((1 != num) || (u > 63)) {
                        pr2serr("Bad page code value after 'p=' option\n");
                        usage_old();
                        return SG_LIB_SYNTAX_ERROR;
                    }
                    op->pg_code = u;
                } else if (2 == sscanf(cp + 2, "%x,%x", &u, &uu)) {
                    if (uu > 255) {
                        pr2serr("Bad subpage code value after 'p=' option\n");
                        usage_old();
                        return SG_LIB_SYNTAX_ERROR;
                    }
                    op->pg_code = u;
                    op->subpg_code = uu;
                    op->subpg_code_given = true;
                } else {
                    pr2serr("Bad page code, subpage code sequence after 'p=' "
                            "option\n");
                    usage_old();
                    return SG_LIB_SYNTAX_ERROR;
                }
            } else if (0 == strncmp("subp=", cp, 5)) {
                num = sscanf(cp + 5, "%x", &u);
                if ((1 != num) || (u > 255)) {
                    pr2serr("Bad sub page code after 'subp=' option\n");
                    usage_old();
                    return SG_LIB_SYNTAX_ERROR;
                }
                op->subpg_code = u;
                op->subpg_code_given = true;
                if (-1 == op->pg_code)
                    op->pg_code = 0;
            } else if (0 == strncmp("-old", cp, 4))
                ;
            else if (jmp_out) {
                pr2serr("Unrecognized option: %s\n", cp);
                usage_old();
                return SG_LIB_SYNTAX_ERROR;
            }
        } else if (0 == op->device_name)
            op->device_name = cp;
        else {
            pr2serr("too many arguments, got: %s, not expecting: %s\n",
                    op->device_name, cp);
            usage_old();
            return SG_LIB_SYNTAX_ERROR;
        }
    }
    return 0;
}

/* Process command line options. First check using new option format unless
 * the SG3_UTILS_OLD_OPTS environment variable is defined which causes the
 * old option format to be checked first. Both new and old format can be
 * countermanded by a '-O' and '-N' options respectively. As soon as either
 * of these options is detected (when processing the other format), processing
 * stops and is restarted using the other format. Clear? */
static int
parse_cmd_line(struct opts_t * op, int argc, char * argv[])
{
    int res;
    char * cp;

    cp = getenv("SG3_UTILS_OLD_OPTS");
    if (cp) {
        op->opt_new = false;
        res = old_parse_cmd_line(op, argc, argv);
        if ((0 == res) && op->opt_new)
            res = new_parse_cmd_line(op, argc, argv);
    } else {
        op->opt_new = true;
        res = new_parse_cmd_line(op, argc, argv);
        if ((0 == res) && (! op->opt_new))
            res = old_parse_cmd_line(op, argc, argv);
    }
    return res;
}

static void
dStrRaw(const uint8_t * str, int len)
{
    int k;

    for (k = 0; k < len; ++k)
        printf("%c", str[k]);
}

/* Note to coverity: this function is safe as long as the page_code_desc
 * objects pointed to by pcdp have a sentinel object at the end of each
 * array. And they do by design.*/
static int
count_desc_elems(const struct page_code_desc * pcdp)
{
    int k;

    for (k = 0; k < 1024; ++k, ++pcdp) {
        if (NULL == pcdp->acron)
            return k;
    }
    pr2serr("%s: sanity check trip, invalid pc_desc table\n", __func__);
    return k;
}

/* Returns pointer to base of table for scsi_ptype or pointer to common
 * table if scsi_ptype is -1. Yields numbers of elements in returned
 * table via pointer sizep. If scsi_ptype not known then returns NULL
 * with *sizep set to zero. */
static struct page_code_desc *
get_mpage_tbl_size(int scsi_ptype, int * sizep)
{
    switch (scsi_ptype)
    {
        case -1:        /* common list */
            *sizep = count_desc_elems(pc_desc_common);
            return &pc_desc_common[0];
        case PDT_DISK:         /* disk (direct access) type devices */
        case PDT_WO:
        case PDT_OPTICAL:
            *sizep = count_desc_elems(pc_desc_disk);
            return &pc_desc_disk[0];
        case PDT_TAPE:         /* tape devices */
        case PDT_PRINTER:
            *sizep = count_desc_elems(pc_desc_tape);
            return &pc_desc_tape[0];
        case PDT_MMC:         /* cd/dvd/bd devices */
            *sizep = count_desc_elems(pc_desc_cddvd);
            return &pc_desc_cddvd[0];
        case PDT_MCHANGER:         /* medium changer devices */
            *sizep = count_desc_elems(pc_desc_smc);
            return &pc_desc_smc[0];
        case PDT_SAC:       /* storage array devices */
            *sizep = count_desc_elems(pc_desc_scc);
            return &pc_desc_scc[0];
        case PDT_SES:       /* enclosure services devices */
            *sizep = count_desc_elems(pc_desc_ses);
            return &pc_desc_ses[0];
        case PDT_RBC:       /* simplified direct access device */
            *sizep = count_desc_elems(pc_desc_rbc);
            return &pc_desc_rbc[0];
        case PDT_ADC:       /* automation device/interface */
            *sizep = count_desc_elems(pc_desc_adc);
            return &pc_desc_adc[0];
        case PDT_ZBC:
            *sizep = count_desc_elems(pc_desc_zbc);
            return &pc_desc_zbc[0];
    }
    *sizep = 0;
    return NULL;
}


static struct page_code_desc *
get_mpage_trans_tbl_size(int t_proto, int * sizep)
{
    switch (t_proto)
    {
        case TPROTO_FCP:
            *sizep = count_desc_elems(pc_desc_t_fcp);
            return &pc_desc_t_fcp[0];
        case TPROTO_SPI:
            *sizep = count_desc_elems(pc_desc_t_spi4);
            return &pc_desc_t_spi4[0];
        case TPROTO_SAS:
            *sizep = count_desc_elems(pc_desc_t_sas);
            return &pc_desc_t_sas[0];
        case TPROTO_ADT:
            *sizep = count_desc_elems(pc_desc_t_adc);
            return &pc_desc_t_adc[0];
    }
    *sizep = 0;
    return NULL;
}

static const char *
find_page_code_desc(int page_num, int subpage_num, int scsi_ptype,
                    bool encserv, bool mchngr, int t_proto)
{
    int k, num, decayed_pdt;
    const struct page_code_desc * pcdp;

    if (t_proto >= 0) {
        pcdp = get_mpage_trans_tbl_size(t_proto, &num);
        if (pcdp) {
            for (k = 0; k < num; ++k, ++pcdp) {
                if ((page_num == pcdp->page_code) &&
                    (subpage_num == pcdp->subpage_code))
                    return pcdp->desc;
                else if (page_num < pcdp->page_code)
                    break;
            }
        }
    }
try_again:
    pcdp = get_mpage_tbl_size(scsi_ptype, &num);
    if (pcdp) {
        for (k = 0; k < num; ++k, ++pcdp) {
            if ((page_num == pcdp->page_code) &&
                (subpage_num == pcdp->subpage_code))
                return pcdp->desc;
            else if (page_num < pcdp->page_code)
                break;
        }
    }
    decayed_pdt = sg_lib_pdt_decay(scsi_ptype);
    if (decayed_pdt != scsi_ptype) {
        scsi_ptype = decayed_pdt;
        goto try_again;
    }
    if ((0xd != scsi_ptype) && encserv) {
        /* check for attached enclosure services processor */
        pcdp = get_mpage_tbl_size(0xd, &num);
        if (pcdp) {
            for (k = 0; k < num; ++k, ++pcdp) {
                if ((page_num == pcdp->page_code) &&
                    (subpage_num == pcdp->subpage_code))
                    return pcdp->desc;
                else if (page_num < pcdp->page_code)
                    break;
            }
        }
    }
    if ((0x8 != scsi_ptype) && mchngr) {
        /* check for attached medium changer device */
        pcdp = get_mpage_tbl_size(0x8, &num);
        if (pcdp) {
            for (k = 0; k < num; ++k, ++pcdp) {
                if ((page_num == pcdp->page_code) &&
                    (subpage_num == pcdp->subpage_code))
                    return pcdp->desc;
                else if (page_num < pcdp->page_code)
                    break;
            }
        }
    }
    pcdp = get_mpage_tbl_size(-1, &num);
    for (k = 0; k < num; ++k, ++pcdp) {
        if ((page_num == pcdp->page_code) &&
            (subpage_num == pcdp->subpage_code))
            return pcdp->desc;
        else if (page_num < pcdp->page_code)
            break;
    }
    return NULL;
}

static void
list_page_codes(int scsi_ptype, bool encserv, bool mchngr, int t_proto)
{
    int num, num_ptype, pg, spg, c, d;
    bool valid_transport;
    const struct page_code_desc * dp;
    const struct page_code_desc * pe_dp;
    char b[64];

    valid_transport = ((t_proto >= 0) && (t_proto <= 0xf));
    printf("Page[,subpage]   Name\n");
    printf("=====================\n");
    dp = get_mpage_tbl_size(-1, &num);
    pe_dp = get_mpage_tbl_size(scsi_ptype, &num_ptype);
    while (1) {
        pg = dp ? dp->page_code : PG_CODE_ALL + 1;
        spg = dp ? dp->subpage_code : SPG_CODE_ALL;
        c = (pg << 8) + spg;
        pg = pe_dp ? pe_dp->page_code : PG_CODE_ALL + 1;
        spg = pe_dp ? pe_dp->subpage_code : SPG_CODE_ALL;
        d = (pg << 8) + spg;
        if (valid_transport &&
            ((PROTO_SPECIFIC_1 == c) || (PROTO_SPECIFIC_2 == c)))
            dp = (--num <= 0) ? NULL : (dp + 1); /* skip protocol specific */
        else if (c == d) {
            if (pe_dp) {
                if (pe_dp->subpage_code)
                    printf(" 0x%02x,0x%02x    *  %s\n", pe_dp->page_code,
                           pe_dp->subpage_code, pe_dp->desc);
                else
                    printf(" 0x%02x         *  %s\n", pe_dp->page_code,
                           pe_dp->desc);
                pe_dp = (--num_ptype <= 0) ? NULL : (pe_dp + 1);
            }
            if (dp)
                dp = (--num <= 0) ? NULL : (dp + 1);
        } else if (c < d) {
            if (dp) {
                if (dp->subpage_code)
                    printf(" 0x%02x,0x%02x       %s\n", dp->page_code,
                           dp->subpage_code, dp->desc);
                else
                    printf(" 0x%02x            %s\n", dp->page_code,
                           dp->desc);
                dp = (--num <= 0) ? NULL : (dp + 1);
            }
        } else {
            if (pe_dp) {
                if (pe_dp->subpage_code)
                    printf(" 0x%02x,0x%02x       %s\n", pe_dp->page_code,
                           pe_dp->subpage_code, pe_dp->desc);
                else
                    printf(" 0x%02x            %s\n", pe_dp->page_code,
                           pe_dp->desc);
                pe_dp = (--num_ptype <= 0) ? NULL : (pe_dp + 1);
            }
        }
        if ((NULL == dp) && (NULL == pe_dp))
            break;
    }
    if ((0xd != scsi_ptype) && encserv) {
        /* check for attached enclosure services processor */
        printf("\n    Attached enclosure services processor\n");
        dp = get_mpage_tbl_size(0xd, &num);
        while (dp) {
            if (dp->subpage_code)
                printf(" 0x%02x,0x%02x       %s\n", dp->page_code,
                       dp->subpage_code, dp->desc);
            else
                printf(" 0x%02x            %s\n", dp->page_code,
                       dp->desc);
            dp = (--num <= 0) ? NULL : (dp + 1);
        }
    }
    if ((0x8 != scsi_ptype) && mchngr) {
        /* check for attached medium changer device */
        printf("\n    Attached medium changer device\n");
        dp = get_mpage_tbl_size(0x8, &num);
        while (dp) {
            if (dp->subpage_code)
                printf(" 0x%02x,0x%02x       %s\n", dp->page_code,
                       dp->subpage_code, dp->desc);
            else
                printf(" 0x%02x            %s\n", dp->page_code,
                       dp->desc);
            dp = (--num <= 0) ? NULL : (dp + 1);
        }
    }
    if (valid_transport) {
        printf("\n    Transport protocol: %s\n",
               sg_get_trans_proto_str(t_proto, sizeof(b), b));
        dp = get_mpage_trans_tbl_size(t_proto, &num);
        while (dp) {
            if (dp->subpage_code)
                printf(" 0x%02x,0x%02x       %s\n", dp->page_code,
                       dp->subpage_code, dp->desc);
            else
                printf(" 0x%02x            %s\n", dp->page_code,
                       dp->desc);
            dp = (--num <= 0) ? NULL : (dp + 1);
        }
    }
}

/* Returns 0 for ok, else error value */
static int
examine_pages(int sg_fd, int inq_pdt, bool encserv, bool mchngr,
              const struct opts_t * op)
{
    bool header_printed;
    int k, mresp_len, len, resid;
    int res = 0;
    const int mx_len = op->do_six ? DEF_6_ALLOC_LEN : DEF_ALLOC_LEN;
    const char * cp;
    uint8_t * rbuf;
    uint8_t * free_rbuf = NULL;

    rbuf = sg_memalign(mx_len, 0, &free_rbuf, false);
    if (NULL == rbuf) {
        pr2serr("%s: out of heap\n", __func__);
        return sg_convert_errno(ENOMEM);
    }
    mresp_len = (op->do_raw || op->do_hex) ? mx_len : 4;
    for (header_printed = false, k = 0; k < PG_CODE_MAX; ++k) {
        resid = 0;
        if (op->do_six) {
            res = sg_ll_mode_sense6(sg_fd, 0, 0, k, 0, rbuf, mresp_len,
                                    true, op->verbose);
            if (SG_LIB_CAT_INVALID_OP == res) {
                pr2serr(">>>>>> try again without the '-6' switch for a 10 "
                        "byte MODE SENSE command\n");
                goto out;
            } else if (SG_LIB_CAT_NOT_READY == res) {
                pr2serr("MODE SENSE (6) failed, device not ready\n");
                goto out;
            }
        } else {
            res = sg_ll_mode_sense10_v2(sg_fd, 0, 0, 0, k, 0, rbuf, mresp_len,
                                        0, &resid, true, op->verbose);
            if (SG_LIB_CAT_INVALID_OP == res) {
                pr2serr(">>>>>> try again with a '-6' switch for a 6 byte "
                        "MODE SENSE command\n");
                goto out;
            } else if (SG_LIB_CAT_NOT_READY == res) {
                pr2serr("MODE SENSE (10) failed, device not ready\n");
                goto out;
            }
        }
        if (0 == res) {
            len = sg_msense_calc_length(rbuf, mresp_len, op->do_six, NULL);
            if (resid > 0) {
                mresp_len -= resid;
                if (mresp_len < 0) {
                    pr2serr("%s: MS(10) resid=%d implies negative response "
                            "length (%d)\n", __func__, resid, mresp_len);
                    res = SG_LIB_WILD_RESID;
                    goto out;
                }
            }
            if (len > mresp_len)
                len = mresp_len;
            if (op->do_raw) {
                dStrRaw(rbuf, len);
                continue;
            }
            if (op->do_hex > 2) {
                hex2stdout(rbuf, len, -1);
                continue;
            }
            if (! header_printed) {
                printf("Discovered mode pages:\n");
                header_printed = true;
            }
            cp = find_page_code_desc(k, 0, inq_pdt, encserv, mchngr, -1);
            if (cp)
                printf("    %s\n", cp);
            else
                printf("    [0x%x]\n", k);
            if (op->do_hex)
                hex2stdout(rbuf, len, 1);
        } else if (op->verbose) {
            char b[80];

            sg_get_category_sense_str(res, sizeof(b), b, op->verbose - 1);
            pr2serr("MODE SENSE (%s) failed: %s\n", (op->do_six ? "6" : "10"),
                    b);
        }
    }
out:
    if (free_rbuf)
        free(free_rbuf);
    return res;
}

static const char * pg_control_str_arr[] = {
    "current",
    "changeable",
    "default",
    "saved",
};


int
main(int argc, char * argv[])
{
    bool resp_mode6, longlba, spf;
    bool encserv = false;
    bool mchngr = false;
    uint8_t uc;
    int k, num, len, res, md_len, bd_len, page_num, resid;
    int density_code_off, t_proto, inq_pdt, num_ua_pages, vb;
    int sg_fd = -1;
    int ret = 0;
    int rsp_buff_sz = DEF_ALLOC_LEN;
    const char * descp;
    struct opts_t * op;
    uint8_t * rsp_buff = NULL;
    uint8_t * free_rsp_buff = NULL;
    uint8_t * bp;
    const char * cdbLenStr;
    struct sg_simple_inquiry_resp inq_out;
    struct opts_t opts;
    char b[80];
    char ebuff[EBUFF_SZ];
    char pdt_name[64];

    op = &opts;
    memset(op, 0, sizeof(opts));
    op->pg_code = -1;
    res = parse_cmd_line(op, argc, argv);
    if (res)
        return (SG_LIB_OK_FALSE == res) ? 0 : res;
    if (op->do_help) {
        usage_for(op);
        return 0;
    }
#ifdef DEBUG
    pr2serr("In DEBUG mode, ");
    if (op->verbose_given && op->version_given) {
        pr2serr("but override: '-vV' given, zero verbose and continue\n");
        op->verbose_given = false;
        op->version_given = false;
        op->verbose = 0;
    } else if (! op->verbose_given) {
        pr2serr("set '-vv'\n");
        op->verbose = 2;
    } else
        pr2serr("keep verbose=%d\n", op->verbose);
#else
    if (op->verbose_given && op->version_given)
        pr2serr("Not in DEBUG mode, so '-vV' has no special action\n");
#endif
    if (op->version_given) {
        pr2serr("Version string: %s\n", version_str);
        return 0;
    }
    vb = op->verbose;
    if (vb && op->page_acron) {
        pr2serr("page acronynm: '%s' maps to page_code=0x%x",
                op->page_acron, op->pg_code);
        if (op->subpg_code > 0)
            pr2serr(", subpage_code=0x%x\n", op->subpg_code);
        else
            pr2serr("\n");
    }

    if (NULL == op->device_name) {
        if (op->do_list) {
            if ((op->pg_code < 0) || (op->pg_code > PG_CODE_MAX)) {
                printf("    Assume peripheral device type: disk\n");
                list_page_codes(0, false, false, -1);
            } else {
                printf("    peripheral device type: %s\n",
                       sg_get_pdt_str(op->pg_code, sizeof(pdt_name),
                                      pdt_name));
                if (op->subpg_code_given)
                    list_page_codes(op->pg_code, false, false,
                                    op->subpg_code);
                else
                    list_page_codes(op->pg_code, false, false, -1);
            }
            return 0;
        }
        pr2serr("No DEVICE argument given\n\n");
        usage_for(op);
        return SG_LIB_SYNTAX_ERROR;
    }

    if (op->do_examine && (op->pg_code >= 0)) {
        pr2serr("can't give '-e' and a page number\n");
        return SG_LIB_CONTRADICT;
    }

    if (op->do_six && op->do_llbaa) {
        pr2serr("LLBAA not defined for MODE SENSE 6, try without '-L'\n");
        return SG_LIB_CONTRADICT;
    }
    if (op->maxlen > 0) {
        if (op->do_six && (op->maxlen > 255)) {
            pr2serr("For Mode Sense (6) maxlen cannot exceed 255\n");
            return SG_LIB_SYNTAX_ERROR;
        }
        rsp_buff = sg_memalign(op->maxlen, 0, &free_rsp_buff, false);
        rsp_buff_sz = op->maxlen;
    } else {    /* maxlen == 0 */
        rsp_buff = sg_memalign(rsp_buff_sz, 0, &free_rsp_buff, false);
        if (op->do_six)
            rsp_buff_sz = DEF_6_ALLOC_LEN;
    }
    if (NULL == rsp_buff) {     /* check for both sg_memalign()s */
        pr2serr("Unable to allocate %d bytes on heap\n", rsp_buff_sz);
        return sg_convert_errno(ENOMEM);
    }
    /* If no pages or list selected than treat as 'a' */
    if (! ((op->pg_code >= 0) || op->do_all || op->do_list || op->do_examine))
        op->do_all = 1;

    if (op->do_raw) {
        if (sg_set_binary_mode(STDOUT_FILENO) < 0) {
            perror("sg_set_binary_mode");
            ret = SG_LIB_FILE_ERROR;
            goto fini;
        }
    }

    if ((sg_fd = sg_cmds_open_device(op->device_name, ! op->o_readwrite,
                                     vb)) < 0) {
        pr2serr("error opening file: %s: %s\n", op->device_name,
                safe_strerror(-sg_fd));
        ret = sg_convert_errno(-sg_fd);
        goto fini;
    }

    if ((res = sg_simple_inquiry(sg_fd, &inq_out, true, vb))) {
        pr2serr("%s doesn't respond to a SCSI INQUIRY\n", op->device_name);
        ret = (res > 0) ? res : sg_convert_errno(-res);
        goto fini;
    }
    inq_pdt = inq_out.peripheral_type;
    encserv = !! (0x40 & inq_out.byte_6);
    mchngr = !! (0x8 & inq_out.byte_6);
    if ((0 == op->do_raw) && (op->do_hex < 3))
        printf("    %.8s  %.16s  %.4s   peripheral_type: %s [0x%x]\n",
               inq_out.vendor, inq_out.product, inq_out.revision,
               sg_get_pdt_str(inq_pdt, sizeof(pdt_name), pdt_name), inq_pdt);
    if (op->do_list) {
        if (op->subpg_code_given)
            list_page_codes(inq_pdt, encserv, mchngr, op->subpg_code);
        else
            list_page_codes(inq_pdt, encserv, mchngr, -1);
        goto fini;
    }
    if (op->do_examine) {
        ret = examine_pages(sg_fd, inq_pdt, encserv, mchngr, op);
        goto fini;
    }
    if (PG_CODE_ALL == op->pg_code) {
        if (0 == op->do_all)
            ++op->do_all;
    } else if (op->do_all)
        op->pg_code = PG_CODE_ALL;
    if (op->do_all > 1)
        op->subpg_code = SPG_CODE_ALL;

    if (op->do_raw > 1) {
        if (op->do_all) {
            if (op->opt_new)
                pr2serr("'-R' requires a specific (sub)page, not all\n");
            else
                pr2serr("'-r' requires a specific (sub)page, not all\n");
            usage_for(op);
            ret = SG_LIB_CONTRADICT;
            goto fini;
        }
    }

    resid = 0;
    if (op->do_six) {
        res = sg_ll_mode_sense6(sg_fd, op->do_dbd, op->page_control,
                                op->pg_code, op->subpg_code, rsp_buff,
                                rsp_buff_sz, true, vb);
        if (SG_LIB_CAT_INVALID_OP == res)
            pr2serr(">>>>>> try again without the '-6' switch for a 10 byte "
                    "MODE SENSE command\n");
    } else {
        res = sg_ll_mode_sense10_v2(sg_fd, op->do_llbaa, op->do_dbd,
                                    op->page_control, op->pg_code,
                                    op->subpg_code, rsp_buff, rsp_buff_sz,
                                    0, &resid, true, vb);
        if (SG_LIB_CAT_INVALID_OP == res)
            pr2serr(">>>>>> try again with a '-6' switch for a 6 byte MODE "
                    "SENSE command\n");
    }
    if (SG_LIB_CAT_ILLEGAL_REQ == res) {
        if (op->subpg_code > 0)
            pr2serr("invalid field in cdb (perhaps subpages not "
                    "supported)\n");
        else if (op->page_control > 0)
            pr2serr("invalid field in cdb (perhaps page control (PC) not "
                    "supported)\n");
        else
            pr2serr("invalid field in cdb (perhaps page 0x%x not "
                    "supported)\n", op->pg_code);
    } else if (res) {
        sg_get_category_sense_str(res, sizeof(b), b, vb);
        pr2serr("%s\n", b);
    }
    ret = res;
    if (0 == res) {
        int medium_type, specific, headerlen;

        ret = 0;
        resp_mode6 = op->do_six;
        if (op->do_flexible) {
            num = rsp_buff[0];
            if (op->do_six && (num < 3))
                resp_mode6 = false;
            if ((! op->do_six) && (num > 5)) {
                if ((num > 11) && (0 == (num % 2)) && (0 == rsp_buff[4]) &&
                    (0 == rsp_buff[5]) && (0 == rsp_buff[6])) {
                    rsp_buff[1] = num;
                    rsp_buff[0] = 0;
                    pr2serr(">>> msense(10) but resp[0]=%d and not msense(6) "
                            "response so fix length\n", num);
                } else
                    resp_mode6 = true;
            }
        }
        cdbLenStr = resp_mode6 ? "6" : "10";
        if (op->do_raw || (1 == op->do_hex) || (op->do_hex > 2))
            ;
        else {
            if (resp_mode6 == op->do_six)
                printf("Mode parameter header from MODE SENSE(%s):\n",
                       cdbLenStr);
            else
                printf(" >>> Mode parameter header from MODE SENSE(%s),\n"
                       "     decoded as %s byte response:\n",
                       cdbLenStr, (resp_mode6 ? "6" : "10"));
        }
        rsp_buff_sz -= resid;
        if (rsp_buff_sz < 0) {
            pr2serr("MS(%s) resid=%d implies negative response length "
                    "(%d)\n", cdbLenStr, resid, rsp_buff_sz);
            ret = SG_LIB_WILD_RESID;
            goto fini;
        }
        if (resp_mode6) {
            if (rsp_buff_sz < 4) {
                pr2serr("MS(6) resid=%d implies abridged header length "
                        "(%d)\n", resid, rsp_buff_sz);
                ret = SG_LIB_WILD_RESID;
                goto fini;
            }
            headerlen = 4;
            medium_type = rsp_buff[1];
            specific = rsp_buff[2];
            longlba = false;
        } else {        /* MODE SENSE(10) with resid */
            if (rsp_buff_sz < 8) {
                pr2serr("MS(10) resid=%d implies abridged header length "
                        "(%d)\n", resid, rsp_buff_sz);
                ret = SG_LIB_WILD_RESID;
                goto fini;
            }
            headerlen = 8;
            medium_type = rsp_buff[2];
            specific = rsp_buff[3];
            longlba = !!(rsp_buff[4] & 1);
        }
        md_len = sg_msense_calc_length(rsp_buff, rsp_buff_sz, resp_mode6,
                                       &bd_len);
        if (md_len < 0) {
            pr2serr("MS(%s): sg_msense_calc_length() failed\n", cdbLenStr);
            ret = SG_LIB_CAT_MALFORMED;
            goto fini;
        }
        md_len = (md_len < rsp_buff_sz) ? md_len : rsp_buff_sz;
        if ((bd_len + headerlen) > md_len) {
            pr2serr("Invalid block descriptor length=%d, ignore\n", bd_len);
            bd_len = 0;
        }
        if (op->do_raw || (op->do_hex > 2)) {
            if (1 == op->do_raw)
                dStrRaw(rsp_buff, md_len);
            else if (op->do_raw > 1) {
                bp = rsp_buff + bd_len + headerlen;
                md_len -= bd_len + headerlen;
                spf = !!(bp[0] & 0x40);
                len = (spf ? (sg_get_unaligned_be16(bp + 2) + 4) :
                             (bp[1] + 2));
                len = (len < md_len) ? len : md_len;
                for (k = 0; k < len; ++k)
                    printf("%02x\n", bp[k]);
            } else
                hex2stdout(rsp_buff, md_len, -1);
            goto fini;
        }
        if (1 == op->do_hex) {
            hex2stdout(rsp_buff, md_len, 1);
            goto fini;
        } else if (op->do_hex > 1) {
            hex2stdout(rsp_buff, headerlen, 1);
            goto fini;
        }
        if ((PDT_DISK == inq_pdt) || (PDT_ZBC == inq_pdt))
            printf("  Mode data length=%d, medium type=0x%.2x, WP=%d,"
                   " DpoFua=%d, longlba=%d\n", md_len, medium_type,
                   !!(specific & 0x80), !!(specific & 0x10), (int)longlba);
        else
            printf("  Mode data length=%d, medium type=0x%.2x, specific"
                   " param=0x%.2x, longlba=%d\n", md_len, medium_type,
                   specific, (int)longlba);
        if (md_len > rsp_buff_sz) {
            printf("Only fetched %d bytes of response, truncate output\n",
                   rsp_buff_sz);
            md_len = rsp_buff_sz;
            if (bd_len + headerlen > rsp_buff_sz)
                bd_len = rsp_buff_sz - headerlen;
        }
        if (! op->do_dbout) {
            printf("  Block descriptor length=%d\n", bd_len);
            if (bd_len > 0) {
                len = 8;
                density_code_off = 0;
                num = bd_len;
                if (longlba) {
                    printf("> longlba direct access device block "
                           "descriptors:\n");
                    len = 16;
                    density_code_off = 8;
                }
                else if ((PDT_DISK == inq_pdt) || (PDT_ZBC == inq_pdt)) {
                    printf("> Direct access device block descriptors:\n");
                    density_code_off = 4;
                }
                else
                    printf("> General mode parameter block descriptors:\n");

                bp = rsp_buff + headerlen;
                while (num > 0) {
                    printf("   Density code=0x%x\n",
                           *(bp + density_code_off));
                    hex2stdout(bp, len, 1);
                    bp += len;
                    num -= len;
                }
                printf("\n");
            }
        }
        bp = rsp_buff + bd_len + headerlen;    /* start of mode page(s) */
        md_len -= bd_len + headerlen;           /* length of mode page(s) */
        num_ua_pages = 0;
        for (k = 0; md_len > 0; ++k) { /* got mode page(s) */
            if ((k > 0) && (! op->do_all) &&
                (SPG_CODE_ALL != op->subpg_code)) {
                pr2serr("Unexpectedly received extra mode page responses, "
                        "ignore\n");
                break;
            }
            uc = *bp;
            spf = !!(uc & 0x40);
            len = (spf ? (sg_get_unaligned_be16(bp + 2) + 4) : (bp[1] + 2));
            page_num = bp[0] & PG_CODE_MASK;
            if (0x0 == page_num) {
                ++num_ua_pages;
                if((num_ua_pages > 3) && (md_len > 0xa00)) {
                    pr2serr(">>> Seen 3 unit attention pages (only one "
                            "should be at end)\n     and mpage length=%d, "
                            "looks malformed, try '-f' option\n", md_len);
                    break;
                }
            }
            if (op->do_hex) {
                if (spf)
                    printf(">> page_code=0x%x, subpage_code=0x%x, page_cont"
                           "rol=%d\n", page_num, bp[1], op->page_control);
                else
                    printf(">> page_code=0x%x, page_control=%d\n", page_num,
                           op->page_control);
            } else {
                descp = NULL;
                if ((0x18 == page_num) || (0x19 == page_num)) {
                    t_proto = (spf ? bp[5] : bp[2]) & 0xf;
                    descp = find_page_code_desc(page_num, (spf ? bp[1] : 0),
                                                inq_pdt, encserv, mchngr,
                                                t_proto);
                } else
                    descp = find_page_code_desc(page_num, (spf ? bp[1] : 0),
                                                inq_pdt, encserv, mchngr, -1);
                if (NULL == descp) {
                    if (spf)
                        snprintf(ebuff, EBUFF_SZ, "0x%x, subpage_code: 0x%x",
                                 page_num, bp[1]);
                    else
                        snprintf(ebuff, EBUFF_SZ, "0x%x", page_num);
                }
                if (descp)
                    printf(">> %s, page_control: %s\n", descp,
                           pg_control_str_arr[op->page_control]);
                else
                    printf(">> page_code: %s, page_control: %s\n", ebuff,
                           pg_control_str_arr[op->page_control]);
            }
            num = (len > md_len) ? md_len : len;
            if ((k > 0) && (num > UNLIKELY_ABOVE_LEN)) {
                num = UNLIKELY_ABOVE_LEN;
                pr2serr(">>> page length (%d) > %d bytes, unlikely, trim\n"
                        "    Try '-f' option\n", len, num);
            }
            hex2stdout(bp, num , 1);
            bp += len;
            md_len -= len;
        }
    }

fini:
    if (sg_fd >= 0)
        sg_cmds_close_device(sg_fd);
    if (free_rsp_buff)
        free(free_rsp_buff);
    if (0 == vb) {
        if (! sg_if_can2stderr("sg_modes failed: ", ret))
            pr2serr("Some error occurred, try again with '-v' or '-vv' for "
                    "more information\n");
    }
    return (ret >= 0) ? ret : SG_LIB_CAT_OTHER;
}