libmsr.h

Go to the documentation of this file.

/* Everyone must include libmsr.h or they're doing it wrong! */
#include <sys/types.h>
#include <sys/stat.h>
#include <fcntl.h>
#include <termios.h>
#include <stdint.h>

#define LIBMSR_ERR_OK 0x0

#define LIBMSR_ERR_GENERIC 0x1000

#define LIBMSR_ERR_ISO 0x1100

#define LIBMSR_ERR_DEVICE 0x2000

#define LIBMSR_ERR_SERIAL 0x4000

#define MSR_MAX_TRACK_LEN 255

#define MSR_MAX_TRACKS 3

#define MSR_BLOCKING O_NONBLOCK
#define MSR_BAUD B9600

#define MSR_ESC 0x1B

#define MSR_FS 0x1C

#define MSR_STS_OK 0x30

#define MSR_STS_ERR 0x41

typedef struct msr_cmd {
    uint8_t msr_esc; 
    uint8_t msr_cmd; 
} msr_cmd_t;

#define MSR_CMD_READ 0x72

#define MSR_CMD_WRITE 0x77

#define MSR_CMD_RAW_READ 0x6D

#define MSR_CMD_RAW_WRITE 0x6E

#define MSR_STS_RW_ERR 0x31

#define MSR_STS_RW_CMDFMT_ERR 0x32

#define MSR_STS_RW_CMDBAD_ERR 0x34

#define MSR_STS_RW_SWIPEBAD_ERR 0x39

typedef struct msr_end {
    uint8_t msr_enddelim;
    uint8_t msr_fs;
    uint8_t msr_esc;
    uint8_t msr_sts;
} msr_end_t;

/*
 * Read/write start and end delimiters.
 * The empty delimiter occurs when reading a track with no data.
 */

#define MSR_RW_START 0x73 /* 's' */
#define MSR_RW_END 0x3F /* '?' */
#define MSR_RW_BAD 0x2A /* '*' */
#define MSR_RW_EMPTY 0x2B /* '+' */

#define MSR_CMD_DIAG_COMM 0x65

#define MSR_STS_COMM_OK 0x79

#define MSR_CMD_DIAG_SENSOR 0x86

#define MSR_STS_SENSOR_OK MSR_STS_OK

#define MSR_CMD_DIAG_RAM 0x87

#define MSR_STS_RAM_OK MSR_STS_OK

#define MSR_STS_RAM_ERR MSR_STS_ERR

#define MSR_CMD_SLZ 0x7A

#define MSR_STS_SLZ_OK MSR_STS_OK

#define MSR_STS_SLZ_ERR MSR_STS_ERR

#define MSR_CMD_CLZ 0x6C

typedef struct msr_lz {
    uint8_t msr_esc; 
    uint8_t msr_lz_tk1_3; 
    uint8_t msr_lz_tk2; 
} msr_lz_t;

#define MSR_CMD_ERASE 0x63

#define MSR_STS_ERASE_OK MSR_STS_OK

#define MSR_STS_ERASE_ERR MSR_STS_ERR

#define MSR_ERASE_TK1 0x00

#define MSR_ERASE_TK2 0x02

#define MSR_ERASE_TK3 0x04

#define MSR_ERASE_TK1_TK2 0x03

#define MSR_ERASE_TK1_TK3 0x05

#define MSR_ERASE_TK2_TK3 0x06

#define MSR_ERASE_ALL 0x07

#define MSR_CMD_SETBPI 0x62

#define MSR_STS_BPI_OK MSR_STS_OK

#define MSR_STS_BPI_ERR MSR_STS_ERR

#define MSR_CMD_MODEL 0x74

#define MSR_STS_MODEL_OK 0x53

#define MSR_MODEL_MSR206_1 0x31
#define MSR_MODEL_MSR206_2 0x32
#define MSR_MODEL_MSR206_3 0x33
#define MSR_MODEL_MSR206_5 0x35

typedef struct msr_model {
    uint8_t msr_esc;
    uint8_t msr_model;
    uint8_t msr_s;
} msr_model_t;

#define MSR_CMD_FWREV 0x76

#define MSR_FWREV_FMT "REV?X.XX"

#define MSR_CMD_SETBPC 0x6F

#define MSR_STS_BPC_OK MSR_STS_OK

#define MSR_STS_BPC_ERR MSR_STS_ERR

typedef struct msr_bpc {
    uint8_t msr_bpctk1; 
    uint8_t msr_bpctk2; 
    uint8_t msr_bpctk3; 
} msr_bpc_t;

#define MSR_CMD_SETCO_HI 0x78

#define MSR_CMD_SETCO_LO 0x79

#define MSR_STS_CO_OK MSR_STS_OK

#define MSR_STS_CO_ERR MSR_STS_ERR

#define MSR_CMD_GETCO 0x64

#define MSR_CO_HI 0x68

#define MSR_CO_LO 0x6C

#define MSR_CMD_RESET 0x61

#define MSR_CMD_LED_OFF 0x81

#define MSR_CMD_LED_ON 0x82

#define MSR_CMD_LED_GRN_ON 0x83

#define MSR_CMD_LED_YLW_ON 0x84

#define MSR_CMD_LED_RED_ON 0x85

typedef struct msr_track {
    uint8_t msr_tk_data[MSR_MAX_TRACK_LEN]; 
    uint8_t msr_tk_len; 
} msr_track_t;

typedef struct msr_tracks {
    msr_track_t msr_tracks[MSR_MAX_TRACKS]; 
} msr_tracks_t;

extern int msr_serial_open(char *path, int *fd, int blocking, speed_t baud);

extern int msr_serial_close(int fd);

extern int msr_serial_readchar(int fd, uint8_t *c);

extern int msr_serial_write(int fd, void *buf, size_t len);

extern int msr_serial_read(int fd, void *buf, size_t len);

extern int msr_zeros(int fd, msr_lz_t *lz);

extern int msr_commtest(int fd);

extern int msr_init(int fd);

extern int msr_fwrev(int fd, uint8_t *buf);

extern int msr_model(int fd, uint8_t *buf);

extern int msr_sensor_test(int fd);

extern int msr_ram_test(int fd);

extern int msr_get_co(int fd);

extern int msr_set_hi_co(int fd);

extern int msr_set_lo_co(int fd);

extern int msr_reset(int fd);

extern int msr_iso_read(int fd, msr_tracks_t *tracks);

extern int msr_iso_write(int fd, msr_tracks_t *tracks);

extern int msr_raw_read(int fd, msr_tracks_t *tracks);

extern int msr_raw_write(int fd, msr_tracks_t *tracks);

extern int msr_erase(int fd, uint8_t tracks);

extern int msr_flash_led(int fd, uint8_t led);

extern int msr_set_bpi(int fd, uint8_t bpi);

extern int msr_set_bpc(int fd, uint8_t bpc1, uint8_t bpc2, uint8_t bpc3);

extern int msr_reverse_tracks(msr_tracks_t *tracks);

extern int msr_reverse_track(msr_track_t *track);

extern void msr_pretty_output_hex(int fd, msr_tracks_t tracks);

extern void msr_pretty_output_string(int fd, msr_tracks_t tracks);

extern void msr_pretty_output_bits(int fd, msr_tracks_t tracks);

extern void msr_pretty_printer_hex(msr_tracks_t tracks);

extern void msr_pretty_printer_string(msr_tracks_t tracks);

extern void msr_pretty_printer_bits(msr_tracks_t tracks);

extern const unsigned char msr_reverse_byte(const unsigned char byte);