mp_api.h

Go to the documentation of this file.

/*
 * Copyright (c) 2023 HPMicro
 *
 * SPDX-License-Identifier: BSD-3-Clause
 *
 */
 
#ifndef MP_API_H
#define MP_API_H
 
#include "mp_common.h"
 
/***********************************************************************************************************************
 *
 * Definitions
 *
 **********************************************************************************************************************/
#define MP_VERSION         "V0.1.0"
 
#ifdef __cplusplus
extern "C" {
#endif
 
int hpm_mp_api_get_default(hpm_mp_t* mp_t);
 
int hpm_mp_pwm_pair_get_default(uint8_t pwm_pair_index, uint32_t freq, hpm_pwm_pair_t* pwm_pair_t);
 
int hpm_mp_pwm_get_default(uint8_t pwm_index, uint32_t freq, hpm_pwm_t* pwm_t);
 
int hpm_mp_adc_get_default(uint8_t adc_index, hpm_adc_t* adc_t);
 
int hpm_mp_api_init(hpm_mp_t* mp_t);
 
uint32_t hpm_mp_api_pwmpair_get_reload_of_freq(hpm_pwm_pair_t* pwm_pair_t, uint32_t freq);
 
int hpm_mp_api_pwmpair_set_reload_and_duty(hpm_pwm_pair_t* pwm_pair_t, uint32_t reload_count, uint32_t duty_count);
 
int hpm_mp_api_pwmpair_freq(hpm_pwm_pair_t* pwm_pair_t, uint32_t freq);
 
int hpm_mp_api_pwmpair_freq_of_half_duty(hpm_pwm_pair_t* pwm_pair_t, uint32_t freq);
 
int hpm_mp_api_pwmpair_duty(hpm_pwm_pair_t* pwm_pair_t, uint32_t duty);
 
int hpm_mp_api_pwmpair_force_config(hpm_pwm_pair_t* pwm_pair_t, uint8_t index, uint8_t level);
 
void hpm_mp_api_pwmpair_force_enable_output(hpm_pwm_pair_t* pwm_pair_t, uint8_t index);
 
void hpm_mp_api_pwmpair_force_disable_output(hpm_pwm_pair_t* pwm_pair_t, uint8_t index);
 
void hpm_mp_api_pwmpair_fault_software_clear(hpm_pwm_pair_t* pwm_pair_t);
 
int hpm_mp_api_pwm_freq(hpm_pwm_t* pwm_t, uint32_t freq);
 
int hpm_mp_api_pwm_freq_of_half_duty(hpm_pwm_t* pwm_t, uint32_t freq);
 
int hpm_mp_api_pwm_duty(hpm_pwm_t* pwm_t, uint32_t duty);
 
int hpm_mp_api_pwm_force_config(hpm_pwm_t* pwm_t, uint8_t level);
 
void hpm_mp_api_pwm_force_enable_output(hpm_pwm_t* pwm_t);
 
void hpm_mp_api_pwm_force_disable_output(hpm_pwm_t* pwm_t);
 
void hpm_mp_api_pwm_fault_software_clear(hpm_pwm_t* pwm_t);
 
int hpm_mp_api_pwm_pair_trig_set_duty(hpm_pwm_pair_t* pwm_pair_t, uint32_t duty);
 
int hpm_mp_api_pwm_trig_set_duty(hpm_pwm_t* pwm_t, uint32_t duty);
 
int hpm_mp_api_pwm_pair_set_deadzone(hpm_pwm_pair_t* pwm_pair_t, uint32_t start_halfcycle, uint32_t end_halfcycle);
 
int hpm_mp_api_dma_request_enable(bool enable, uint8_t type, void* handle);
 
int hpm_mp_timer_create(uint32_t us, mp_timer_cb cb);
 
int hpm_mp_api_pwm_pair_set_map(const mp_pwm_pair_map_t* map_t, int count);
 
int hpm_mp_api_pwm_set_map(const mp_pwm_map_t* map_t, int count);
 
int hpm_mp_api_adc_set_map(const mp_adc_map_t* map_t, int count);
 
void hpm_mp_api_pair_pwm_io_init(uint8_t pair_index);
 
void hpm_mp_api_pwm_io_init(uint8_t index);
 
void hpm_mp_api_adc_io_init(uint8_t adc_index);
 
#ifdef __cplusplus
}
#endif
 
#endif //MP_API_H