Command Processing; Command Number; Data Length; Data - Magtek MICRSAFE Technical Reference Manual

COMMAND PROCESSING

Firmware in the MSR normally handles card swipes, gets MagnePrint data, and encrypts the data;
it then passes the output to firmware in the MICRSafe for transmission to the host. Firmware in
the MICRSafe controls all functions relating to check reading and handles all communications
between the host and the device. Thus, all commands are received by the MICRSafe firmware,
which, unless instructed otherwise, will attempt to process the command. For this reason,
commands that affect card reading only (which are unknown to the MICRSafe firmware) must be
distinguished from commands which the MICRSafe firmware is equipped to handle. The
convention adopted to enable this necessary distinction is to prefix the data portion of a card
reading command with the literal "MSR". This will cause the MICRSafe firmware not to
process a specific command. Instead, the MICRSafe firmware will pass the command through to
the MSR firmware which will process the command.

COMMAND NUMBER

This one-byte field contains the value of the requested command number. The following table
lists all the existing commands.
Value Command Number
0 Get Property
1 Set Property
2 Reset Device
3 Get Keymap Item
4 Set Keymap Item
5 Save Custom Keymap
7 Send Legacy Command

DATA LENGTH

This one-byte field contains the length of the valid data contained in the Data field.

DATA

This multi-byte field contains command data, if any. Note that the length of this field is fixed at
22 bytes. Valid data should be placed in the field starting at offset 2. Any remaining data after
the valid data should be set to zero. This entire field must always be set even if there is no valid
data. The HID specification requires that Reports be fixed in length. Command data may vary in
length. Therefore, the Report should be filled with zeros after the valid data.
Section 5. USB Communications
Description
Gets a property from the device
Sets a property in the device
Resets the device
Gets a key map item
Sets a key map item
Saves the custom key map
Sends a legacy command
25