msr.h

/******************************************************************************
 *
 * Copyright (C) 2022-2023 Maxim Integrated Products, Inc. (now owned by 
 * Analog Devices, Inc.),
 * Copyright (C) 2023-2024 Analog Devices, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 ******************************************************************************/
 
#ifndef LIBRARIES_PERIPHDRIVERS_INCLUDE_MAX32672_MSR_H_
#define LIBRARIES_PERIPHDRIVERS_INCLUDE_MAX32672_MSR_H_
 
#ifdef __cplusplus
extern "C" {
#endif
 
/***** Definitions *****/
 
#ifndef MSR_NUM_TRACKS
#define MSR_NUM_TRACKS 3
#endif
 
#define MSR_MAX_SAMPLES 1536
 
// Assuming nominal bit density of 210 bpi and 3.375 inch length
#define MSR_MAX_RAW_LEN_BITS (709)
#define MSR_MAX_RAW_LEN_BYTES ((MSR_MAX_RAW_LEN_BITS + 7) / 8)
#define MSR_MAX_RAW_LEN_HALFWORDS ((MSR_MAX_RAW_LEN_BITS + 15) / 16)
 
#define MSR_MAX_DEC_LEN (MSR_MAX_RAW_LEN_BITS / 5)
 
#define MSR_FORWARD 0
#define MSR_REVERSE 1
 
#define MSR_ERR_OK 0x00
#define MSR_ERR_BAD_LEN 0x01
#define MSR_ERR_START_SEN 0x02
#define MSR_ERR_END_SEN 0x04
#define MSR_ERR_OUTLIER 0x08
#define MSR_ERR_PARAM 0x10
#define MSR_ERR_LRC 0x40
#define MSR_ERR_PARITY 0x80
 
typedef struct {
    uint8_t error_code; 
    uint8_t parity_errs; 
    uint8_t lrc; 
    uint8_t direction; 
    uint8_t len; 
    uint16_t speed;
    uint8_t data[MSR_MAX_DEC_LEN]; 
} msr_decoded_track_t;
 
typedef union {
    struct {
        uint16_t time : 9;
        uint16_t amp : 7;
    };
    uint16_t value;
} msr_sample_t;
 
typedef struct {
    uint16_t len;
    msr_sample_t data[MSR_MAX_SAMPLES];
} msr_samples_t;
 
/***** Function Prototypes *****/
 
int msr_init(void);
 
void msr_init_track(unsigned int track);
 
void msr_enable(void);
 
void msr_disable(void);
 
int msr_task(void);
 
unsigned int msr_track_decode(unsigned int track, msr_decoded_track_t *decoded_track);
 
void msr_set_complete_callback(void (*func)(void));
 
unsigned int mcr_get_track_samples(unsigned int track, msr_samples_t *samples);
 
#ifdef __cplusplus
}
#endif
 
#endif // LIBRARIES_PERIPHDRIVERS_INCLUDE_MAX32672_MSR_H_