hpm_qei_encoder.h

Go to the documentation of this file.

/*
 * Copyright (c) 2024 HPMicro
 *
 * SPDX-License-Identifier: BSD-3-Clause
 *
 */
 
#ifndef _HPM_QEI_ENCODER_H
#define _HPM_QEI_ENCODER_H
 
#include "hpm_soc_feature.h"
#include "hpm_plb_drv.h"
#include "hpm_trgm_drv.h"
 
/* @brief Common status code definitions */
enum {
    status_unsupport_plb = MAKE_STATUS(status_group_plb_qei_encoder, 0),
};
 
typedef enum {
    plb_qei_encoder_channel_0 = 0,
    plb_qei_encoder_channel_1 = 1,
    plb_qei_encoder_channel_2 = 2,
    plb_qei_encoder_channel_3 = 3,
    plb_qei_encoder_channel_4 = 4,
    plb_qei_encoder_channel_5 = 5,
    plb_qei_encoder_channel_6 = 6,
    plb_qei_encoder_channel_7 = 7,
} plb_qei_encoder_channel_t;
 
typedef enum {
    plb_ab_mode = 0,
    plb_abz_mode = 1
} plb_qei_encoder_mode_t;
 
typedef struct {
    uint16_t qei_a;
    uint16_t qei_b;
    uint16_t qei_z;
} plb_qei_encoder_trgmux_input_t;
 
typedef struct {
    uint32_t phase_cnt; 
    plb_qei_encoder_trgmux_input_t trgm_input;
    plb_qei_encoder_mode_t mode;
    uint16_t filter_length;
    bool enable_z_pin;  
    bool enable_phase;  
} plb_qei_encoder_cfg_t;
 
#if defined(__cplusplus)
extern "C" {
#endif /* __cplusplus */
 
hpm_stat_t plb_qei_encoder_init(PLB_Type *plb, TRGM_Type *trgm, plb_qei_encoder_channel_t qei_chn, plb_qei_encoder_cfg_t *cfg);
 
uint32_t plb_qei_encoder_get_phase_count(PLB_Type *plb, plb_qei_encoder_channel_t qei_chn);
 
void plb_qei_encoder_set_phase_count(PLB_Type *plb, plb_qei_encoder_channel_t qei_chn, uint32_t val);
 
uint32_t plb_qei_encoder_get_laps_number(PLB_Type *plb, plb_qei_encoder_channel_t qei_chn);
 
void plb_qei_encoder_set_laps_number(PLB_Type *plb, plb_qei_encoder_channel_t qei_chn, int32_t val);
 
#if defined(__cplusplus)
}
#endif /* __cplusplus */
 
#endif