qdec.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.
 *
 ******************************************************************************/
 
/* Define to prevent redundant inclusion */
#ifndef LIBRARIES_PERIPHDRIVERS_INCLUDE_MAX32672_QDEC_H_
#define LIBRARIES_PERIPHDRIVERS_INCLUDE_MAX32672_QDEC_H_
 
/* **** Includes **** */
#include <stdint.h>
#include "qdec_regs.h"
#include "mcr_regs.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
/***************************************************************************************************************
                                    DATA STRUCTURES FOR QDEC INITIALIZATION
***************************************************************************************************************/
 
typedef enum {
    MXC_QDEC_X1_MODE = 0, 
    MXC_QDEC_X2_MODE = 1, 
    MXC_QDEC_x4_MODE, 
} mxc_qdec_counter_mode_t;
 
typedef enum {
    MXC_QDEC_SWAP_CW_A_LEADS_B, 
    MXC_QDEC_SWAP_CW_B_LEADS_A, 
} mxc_qdec_swap_t;
 
typedef enum {
    MXC_QDEC_FILTER_1_SAMPLE =
        MXC_S_QDEC_CTRL_FILTER_1_SAMPLE, 
    MXC_QDEC_FILTER_2_SAMPLES =
        MXC_S_QDEC_CTRL_FILTER_2_SAMPLES, 
    MXC_QDEC_FILTER_3_SAMPLES =
        MXC_S_QDEC_CTRL_FILTER_3_SAMPLES, 
    MXC_QDEC_FILTER_4_SAMPLES =
        MXC_S_QDEC_CTRL_FILTER_4_SAMPLES, 
} mxc_qdec_filter_t;
 
typedef enum {
    MXC_QDEC_STICKY_PULSE = 0, 
    MXC_QDEC_STICKY_MIRROR, 
} mxc_qdec_sticky_t;
 
typedef enum {
    MXC_QDEC_CLKDIV_1 = 0, 
    MXC_QDEC_CLKDIV_2, 
    MXC_QDEC_CLKDIV_4, 
    MXC_QDEC_CLKDIV_8, 
    MXC_QDEC_CLKDIV_16, 
    MXC_QDEC_CLKDIV_32, 
    MXC_QDEC_CLKDIV_64, 
    MXC_QDEC_CLKDIV_128, 
} mxc_qdec_clkdiv_t;
 
typedef enum {
    MXC_QDEC_RST_ON_MAXCNT = 0,
    MXC_QDEC_RST_ON_INDEX,
} mxc_qdec_rst_on_t;
 
typedef enum {
    MXC_QDEC_NONE = 0,
    MXC_QDEC_CAPTURE,
    MXC_QDEC_COMPARE,
} mxc_qdec_function_t;
 
typedef void (*mxc_qdec_cb_t)(void *req, int error);
 
typedef struct {
    mxc_qdec_counter_mode_t mode; 
    mxc_qdec_swap_t swap; 
    mxc_qdec_filter_t sample; 
    mxc_qdec_clkdiv_t clkdiv; 
    mxc_qdec_sticky_t sticky; 
    mxc_qdec_rst_on_t rst; 
    mxc_qdec_function_t func; 
    uint32_t maxcnt; 
    uint32_t initial; 
    uint32_t compare; 
    mxc_qdec_cb_t callback;
} mxc_qdec_req_t;
 
int MXC_QDEC_Init(mxc_qdec_req_t *req);
 
int MXC_QDEC_Shutdown(void);
 
void MXC_QDEC_EnableInt(uint32_t flags);
 
void MXC_QDEC_DisableInt(uint32_t flags);
 
int MXC_QDEC_GetFlags(void);
 
void MXC_QDEC_ClearFlags(uint32_t flags);
 
void MXC_QDEC_SetMaxCount(uint32_t maxCount);
 
int MXC_QDEC_GetMaxCount(void);
 
void MXC_QDEC_SetInitial(uint32_t initial);
 
int MXC_QDEC_GetInitial(void);
 
void MXC_QDEC_SetCompare(uint32_t compare);
 
int MXC_QDEC_GetCompare(void);
 
int MXC_QDEC_GetIndex(void);
 
int MXC_QDEC_GetCapture(void);
 
int MXC_QDEC_Handler(void);
 
int MXC_QDEC_GetPosition(void);
 
int MXC_QDEC_GetDirection(void);
 
#ifdef __cplusplus
}
#endif
 
#endif // LIBRARIES_PERIPHDRIVERS_INCLUDE_MAX32672_QDEC_H_