Support VMS 5.5_2 mode page bits.
[SCSI2SD-V6.git] / software / scsi2sd-util / SCSI2SD_HID.hh
1 //      Copyright (C) 2014 Michael McMaster <michael@codesrc.com>
2 //
3 //      This file is part of SCSI2SD.
4 //
5 //      SCSI2SD is free software: you can redistribute it and/or modify
6 //      it under the terms of the GNU General Public License as published by
7 //      the Free Software Foundation, either version 3 of the License, or
8 //      (at your option) any later version.
9 //
10 //      SCSI2SD is distributed in the hope that it will be useful,
11 //      but WITHOUT ANY WARRANTY; without even the implied warranty of
12 //      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 //      GNU General Public License for more details.
14 //
15 //      You should have received a copy of the GNU General Public License
16 //      along with SCSI2SD.  If not, see <http://www.gnu.org/licenses/>.
17
18 #ifndef SCSI2SD_HID_H
19 #define SCSI2SD_HID_H
20
21 #include "hidapi.h"
22
23 #if __cplusplus >= 201103L
24 #include <cstdint>
25 #else
26 #include <stdint.h>
27 #endif
28
29 #include <string>
30 #include <vector>
31
32 namespace SCSI2SD
33 {
34
35 class HID
36 {
37 public:
38         static const uint16_t VENDOR_ID = 0x04B4; // Cypress
39         static const uint16_t PRODUCT_ID = 0x1337; // SCSI2SD application firmware
40
41         static const int CONFIG_INTERFACE = 0;
42         static const int DEBUG_INTERFACE = 1;
43
44         static const size_t HID_PACKET_SIZE = 64;
45
46         // HID intervals for 4.0.3 firmware: <= 128ms
47         // > 4.0.3 = 32ms.
48         static const size_t HID_TIMEOUT_MS = 256; // 2x HID Interval.
49
50
51         static HID* Open();
52
53         ~HID();
54
55         uint16_t getFirmwareVersion() const { return myFirmwareVersion; }
56         std::string getFirmwareVersionStr() const;
57         uint32_t getSDCapacity() const { return mySDCapacity; }
58         std::vector<uint8_t> getSD_CSD();
59         std::vector<uint8_t> getSD_CID();
60
61         void enterBootloader();
62
63         void readFlashRow(int array, int row, std::vector<uint8_t>& out);
64         void writeFlashRow(int array, int row, const std::vector<uint8_t>& in);
65         bool ping();
66
67         bool readSCSIDebugInfo(std::vector<uint8_t>& buf);
68
69 private:
70         HID(hid_device_info* hidInfo);
71         void destroy();
72         void readDebugData();
73         void readHID(uint8_t* buffer, size_t len);
74         void sendHIDPacket(
75                 const std::vector<uint8_t>& cmd,
76                 std::vector<uint8_t>& out,
77                 size_t responseLength
78                 );
79
80         hid_device_info* myHidInfo;
81         hid_device* myConfigHandle;
82         hid_device* myDebugHandle;
83
84         // Read-only data from the debug interface.
85         uint16_t myFirmwareVersion;
86         uint32_t mySDCapacity;
87 };
88
89 } // namespace
90
91 #endif