hpm_mcl_drivers.h

Go to the documentation of this file.

/*
 * Copyright (c) 2023 HPMicro
 *
 * SPDX-License-Identifier: BSD-3-Clause
 *
 */
#ifndef HPM_MCL_DRIVERS_H
#define HPM_MCL_DRIVERS_H
#include "hpm_mcl_common.h"
 
enum {
    mcl_drivers_init_error = MAKE_STATUS(mcl_group_drivers, 0),
    mcl_drivers_not_ready = MAKE_STATUS(mcl_group_drivers, 1),
    mcl_drivers_update_error = MAKE_STATUS(mcl_group_drivers, 2),
};
 
typedef enum {
    drivers_status_null = 0,
    drivers_status_init = 1,
    drivers_status_run = 2,
    drivers_status_fail = 3,
} mcl_drivers_status_t;
 
typedef enum {
    mcl_drivers_chn_a,
    mcl_drivers_chn_b,
    mcl_drivers_chn_c,
    mcl_drivers_chn_a0,
    mcl_drivers_chn_a1,
    mcl_drivers_chn_b0,
    mcl_drivers_chn_b1,
    mcl_drivers_chn_ah,
    mcl_drivers_chn_al,
    mcl_drivers_chn_bh,
    mcl_drivers_chn_bl,
    mcl_drivers_chn_ch,
    mcl_drivers_chn_cl,
 
} mcl_drivers_channel_t;
 
typedef struct {
    void (*init)(void);
    hpm_mcl_stat_t (*update_duty_cycle)(mcl_drivers_channel_t chn, float duty);
    _FUNC_OPTIONAL_ hpm_mcl_stat_t (*update_frequency)(mcl_drivers_channel_t chn, uint32_t freqc);
    _FUNC_OPTIONAL_ hpm_mcl_stat_t (*update_phase_offset)(mcl_drivers_channel_t chn, int32_t tick);
    hpm_mcl_stat_t (*disable_all_drivers)(void);
    hpm_mcl_stat_t (*enable_all_drivers)(void);
    hpm_mcl_stat_t (*disable_drivers)(mcl_drivers_channel_t chn);
    hpm_mcl_stat_t (*enable_drivers)(mcl_drivers_channel_t chn);
} mcl_drivers_callback_t;
 
typedef struct {
    mcl_drivers_callback_t callback;
} mcl_drivers_cfg_t;
 
typedef struct {
    mcl_drivers_cfg_t *cfg;
    mcl_drivers_status_t status;
} mcl_drivers_t;
 
#ifdef __cplusplus
extern "C" {
#endif
 
hpm_mcl_stat_t hpm_mcl_drivers_init(mcl_drivers_t *drivers, mcl_drivers_cfg_t *cfg);
 
hpm_mcl_stat_t hpm_mcl_drivers_update_bldc_duty(mcl_drivers_t *drivers, float duty_a, float duty_b, float duty_c);
 
hpm_mcl_stat_t hpm_mcl_drivers_update_step_duty(mcl_drivers_t *drivers, float duty_a0, float duty_a1, float duty_b0, float duty_b1);
 
hpm_mcl_stat_t hpm_mcl_disable_all_drivers(mcl_drivers_t *drivers);
 
hpm_mcl_stat_t hpm_mcl_enable_all_drivers(mcl_drivers_t *drivers);
 
hpm_mcl_stat_t hpm_mcl_disable_drivers(mcl_drivers_t *drivers, mcl_drivers_channel_t chn);
 
hpm_mcl_stat_t hpm_mcl_enable_drivers(mcl_drivers_t *drivers, mcl_drivers_channel_t chn);
 
hpm_mcl_stat_t hpm_mcl_drivers_block_update(mcl_drivers_t *drivers, mcl_motor_dir_t dir, uint8_t sector);
 
#ifdef __cplusplus
}
#endif
 
#endif