GC24001/Compenent/axis_motion/axis_motion.h

#ifndef __axis_H__
#define __axis_H__
#include "axis_motion_config.h"

//===================================修改记录=================================//
//2020.05.12 11:48 LXZ
//	1、取消speed_unit参数，所以参数外部自己需要知道倍率，内部只管真实频率
//	2、增加了设置正反转与高速回零的参数设置
//	3、回零增加信号管脚、滤波次数的设置项目
//2020.05.14 00:18 LXZ
//	1、增了设置软件限位点的接口，修改软件限位开启接口
//	2、增加了若干对外的参数读写类型
//	3、修改报警反馈方式为位标志
//2020.05.18 15:40 LXZ
//  1、增加设置编码器回零的接口
//  2、去除对编码器管脚的参数设置，要求必须用接口去操作
//  3、增加了设置齿轮比的对应接口
//  4、增加了设置与读取现实位置的参数对象
//  5、增加了位置与脉冲单位转换接口
//  6、增加了转速与频率单位转换接口
//  7、增加方向读取对象
//2020.05.21 15:17 LXZ
//  1、修正加减速状态值的定义
//  2、修改加减速缓冲为400，会占用更多的内存，但是适配更大的速度
//  3、修改多段速定义
//2020.05.26 14:48
//  1、axis_pp函数与axis_start_pp_task函数增加返回值来表示定向运动是否正常启动
//  2、增加axis_clear_alarm来清除部分非实时报警
//  3、统一一下报警接口名称
//2020.06.17 11:21
//  1、将预览版本的比例开关并入驱动，增加比例开关接口
//     当比例开关打开时，所有的位置相关移动与限位设置都会经过比例计算
//     当开关关闭时，所有定位相关的接口与限位设置都以脉冲为单位，但是位置与脉冲的转换接口是可用的。
//  2、修正软件限位报警自动清零功能。
//  3、增加减速设置项目
//2020.06.20 00:54
//  1、修改齿轮比接口，增加一个放大比例参数 
//  2、定位接口平滑倍率改成宏定义，并加大
//  3、修改了脉冲、位置转换计算方法，采用预比例计算方式，提升运算速度
//2020.06.28 00:54
//  1、根据侧孔钻应用定向修改了齿轮比设置接口
//  2、根据侧孔钻增加速度转频率接口
//  3、为了剥离硬件IO接口，修改原点获取硬件信号方式为指针地址加掩码的方式
//  4、对应修改回零管脚的注册管脚接口
//  5、将配置信息从头文件移到配置文件中，避免不同后期的头文件修改导致应用配置变动
//============================================================================//



/*
#define axis_MODE_PP       1 //位置模式
#define axis_MODE_PV       2 //速度模式
#define axis_MODE_STOP     3 //减速停止
#define axis_MODE_EMGSTOP  4 //急停
*/
typedef struct
{
    unsigned short steps;       //脉冲需要加减速度时保证加减周期需要的脉冲个数
    unsigned short period;       //脉宽
} axis_accdec_t;

typedef enum
{
    AXIS_OUT_ENABLE,
    AXIS_OUT_ERRCLEAR
}axis_output_name;


typedef enum
{
    MV_SERVO_ALARM = (int)(1<<0),       //脉冲需要加减速度时保证加减周期需要的脉冲个数
    MV_HWLM_P_ALARM = (int)(1<<1),       //脉宽
    MV_HWLM_N_ALARM = (int)(1<<2),
    MV_SWLM_P_ALARM = (int)(1<<3),
    MV_SWLM_N_ALARM = (int)(1<<4),
    MV_SWLM_P_PRE_ALARM = (int)(1<<5),
    MV_SWLM_N_PRE_ALARM = (int)(1<<6),
} axis_alarm_enum;

typedef enum
{
    AXIS_MODE_PP,       //PP定位模式
    AXIS_MODE_PV,       //连续运动模式
    AXIS_MODE_PP_TASKS, //多段定位模式
    AXIS_MODE_INTERP,   //插补模式，该模式下不进行加减速，只管将脉冲当量发完后停止
    AXIS_MODE_STOP,     //停止模式
    AXIS_MODE_EMGSTOP   //急停模式
}axis_mode;

typedef enum
{
    AXIS_ALARM_NONE,            //没有报警
    AXIS_ALARM_ERROR,           //报警信号
    AXIS_ALARM_HW_POSITIVE,     //硬件正限位信号
    AXIS_ALARM_HW_NEGATIVE,     //硬件负限位信号
    AXIS_ALARM_SW_POSITIVE,     //软件正限位信号
    AXIS_ALARM_SW_NEGATIVE      //软件负限位信号
}axis_alarm_code_t;

typedef enum
{
    AXIS_ACCDEC_STATUS_ACC = 0,
    AXIS_ACCDEC_STATUS_MID = 1,
    AXIS_ACCDEC_STATUS_DEC = 2
}axis_accdec_status;

typedef struct
{
    int position;
    int speed;
    unsigned short dst_speed_index;
    unsigned short dec_speed_index;
    unsigned short reg_value;
    int target_position;
    int dec_position;
} axis_tasks_data_t;

typedef enum
{
    AXIS_AXIS_NO = 0,           //设置轴号
    AXIS_POSITION = 1,          //设置脉冲位置计数寄存器
    AXIS_PULSENUMBER = 1,
    AXIS_CLOCK = 2,             //设置时钟
    AXIS_PERIOD = 3,            //加减速周期
    AXIS_MIN_STEP = 4,          //设置最小步进
    AXIS_START_SPEED = 5,       //设置最小速度
    AXIS_ACCDEC_MODE = 6,       //设置加减速模式
    AXIS_AAC_LMT = 7,           //设置加加速度限制
    AXIS_ACC_LMT = 8,           //设置加速度限制
    AXIS_DEC_LMT = 9,        //设置速度倍数
    AXIS_ACC_TIME = 10,           //加速时间
    AXIS_DEC_TIME = 11,           //减速时间

    AXIS_HOME_SPACE = 12,        //零点限位的距离
    AXIS_HOME_OFFSET = 13,       //零点偏移
    AXIS_HOME_FIND_SPEED = 14,   //零点查找速度
    AXIS_HOME_HIGH_SPEED = 15,   //高速回零速度
    AXIS_HOME_LOW_SPEED = 16,    //低速回零速度
    AXIS_HOME_HIGH_SPEED_ENABLE = 17, //高速回零使能
    AXIS_FIN_SGN = 18,                //伺服就绪信号
    AXIS_HOME_SGN = 21,               //回零信号
    AXIS_HOME_SLOW_SGN = 22,          //回零减速信号

    AXIS_ERROR_SGN = 23,              //故障信号
    AXIS_HW_POSI_SGN = 24,            //硬件正限位
    AXIS_HW_NEGA_SGN = 25,            //硬件软限位
                                                                
    AXIS_DIR_LEVEL = 26,              //运动方向，1为反转
    AXIS_POSI_SOFT_LMT=27,            //正软件限位
    AXIS_NEGA_SOFT_LMT=28,             //负软件限位

    AXIS_CYCLE_LENGTH =29,            //一圈距离
    AXIS_CYCLE_PLUSE = 30,             //一圈脉冲数
    AXIS_REAL_POSITION = 31,          //经过齿轮比转换后的位置
    AXIS_DIST_POSITION = 31,
    AXIS_CURRENT_DIR = 32,            //获取当前方向  
    AXIS_RATIO_ENABLE = 33,           //齿轮比定位使能
    //AXIS_GEAR_RATIO = 35,             //齿轮放大比例

    AXIS_ENABLE_SGN_LEVEL = 34,       //使能信号电平
}axis_paramter_t;
//轴对象的数据结构
typedef struct
{
    unsigned char axis_no;       //轴号，也是硬件脉冲号
    unsigned char accdec_mode;   //加减速模式，0是直线加减速，1是S加减速
    axis_mode run_mode;          //当前模式

    //输入信号
    struct axis_input_struct {
        int alarm_sgn : 1;      //报警信号  1表示有信号
        int fin_sgn: 1;          //脉冲发送完后到位信号
        int dir_reverse:1;      //伺服方向调转，该位能直接让硬件正反方向调换，但是不会影响软件
        int en_reverse:1;      //使能方向调转，该位能直接让硬件使能电平反转，但是不会影响软件
        int hw_positive_lmt : 1; //正极限位 1表示有信号
        int hw_home_sgn : 1;     //零点     1表示有信号
        int hw_negative_lmt : 1; //负极限位 1表示有信号
        int hw_slow_lmt:1;       //减速信号 1表示有信号
        int sw_lmt_enable:1;       //软件限位功能使能  1表示有信号，这时候软件限位功能才有效
        int home_high_speed_enable:1; //回零高速使能
        int home_encode_sgn_enable:1;     //编码器回零信号使能
        int manual_cw:1;        //手动正转信号
        int manual_ccw:1;       //手动反转信号
        int ratio_enable:1;     //使能齿轮比
        int enable_sgn_level;       //使能信号点评
    } inputs;
    //输出运算信号,用户不应该直接修改该区域，由软件自动判断
    struct axis_out_struct {
        int enable:1;              //使能信号
        int error_clear:1;         //报警清除信号
        int error_alarm : 1;       //故障报警
        int hw_positive_alarm : 1; //硬件正极限位报警
        int hw_negative_alarm : 1; //硬件负极限位报警
        int sw_positive_alarm : 1; //软件正极限位报警
        int sw_negative_alarm : 1; //软件负极限位报警
        int sw_positive_pre_alarm:1;//软件正限位预报警
        int sw_negative_pre_alarm:1;//软件负限位预报警
        int sw_feed_zero_alarm:1;   //进给点为0报警
        int dir:1;                 //方向 1时是正方向，0时是反方向
        int on:1;                  //开关状态，0时是关，1时是开
        int homing:1;              //回零标志位
        int manual_action : 1;     //手动动作标志，当手动有动作的时候，该标志软件会置1，急停时强制清0
    } outputs;

    unsigned long cycle_pluse;   //一圈脉冲数
    unsigned long cycle_length;  //一圈脉冲距离
    unsigned long length_rate;   // 一圈距离相对系统距离计算的倍数，即小数点位数差
    long sw_positive_limit;      //正极软件限位
    long sw_negative_limit;      //负极软件限位

    void (*handle)();           //回调事件

    //加减速配置
    unsigned short period;         //时间单位，ms
    int clock;                     //轴的基础频率

    unsigned short max_aac;      //最大加加速
    unsigned short max_acc;      //最大加速值
    unsigned short max_dec;      //最大减速值
    unsigned short min_steps;    //最小步限制，保证有最小执行计数
    unsigned short acc_time;     //加速时间单位个数
    unsigned short dec_time;     //减速时间单位个数
    unsigned short accdec_count;    //加减速的计数寄存器

    //速度配置
#if defined(AXIS_SPEED_UNIT)
    unsigned short speed_unit;   //速度单位，真实设置速度必须乘以该单位才是真正的频率
#endif
    int start_speed;  //启动速度
    unsigned short target_speed_reg;    //目标速度寄存器值

    //加减速度表
    int acc_table_size; //加速表大小
    int dec_table_size; //减速表大小
    unsigned short acc_number_table[AXIS_MAX_ACCDEC_STEP];  //当前速度满足周期的脉冲数
    unsigned short acc_reg_table[AXIS_MAX_ACCDEC_STEP];     //当前速度对应的寄存器值
#ifndef AXIS_USING_ACC_TABLE_ONLY
    unsigned short dec_number_table[AXIS_MAX_ACCDEC_STEP];  //当前速度满足周期的脉冲数
    unsigned short dec_reg_table[AXIS_MAX_ACCDEC_STEP];     //当前速度对应的寄存器值
#endif
#ifdef AXIS_USING_DEBUG
    unsigned int acc_speed_table[AXIS_MAX_ACCDEC_STEP]; //当前速度满足周期的脉冲数
#ifndef AXIS_USING_ACC_TABLE_ONLY
    unsigned int dec_speed_table[AXIS_MAX_ACCDEC_STEP]; //当前速度对应的寄存器值
#endif
#endif

    //软件自动计算，用户一般情况不应该去修改
    long dec_position;        //开始减速度的脉冲位置
    long position;            //当前的脉冲位置
    long target_position;            //目标的脉冲位置
    long feed;        //只能是-1或者1，用于去掉读取方向的复杂运算
    long encoder;              //编码器输入值
    unsigned short cur_speed_index;  //当前速度编号,针对的是脉冲表
    unsigned short acc_speed_index;  //目标速度编号,针对的是脉冲表
    unsigned short dec_speed_index;  //目标速度编号,针对的是脉冲表
    unsigned short dst_period;       //目标速度的寄存器值
    unsigned char  cur_accdec_status; //当前加减速状态，0表示正在加速，1表示正在减速

    //回零参数配置
    unsigned char home_method;      //回零模式,为0是默认的常规回零模式，后续可能根据需要进行添加
    unsigned char home_step;        //回零状态步

    volatile unsigned short * home_sgn_register;    //回零信号脚寄存器
    unsigned short home_sgn_mask;                   //回零信号位掩
    unsigned short home_sgn_level;	//回零信号有效电平
    unsigned char home_sgn_filter;  //回零信号滤波
    unsigned char home_sgn_count;   //回零信号计数

    volatile unsigned short * home_encoder_sgn_register;    //编码零信号脚寄存器
    unsigned short home_encoder_sgn_mask;                   //编码零信号位掩
    unsigned short home_encoder_sgn_level;	//编码零信号有效电平
    unsigned char home_encoder_sgn_filter;  //编码零信号滤波
    unsigned char home_encoder_sgn_count;   //编码零信号计数

    int home_high_speed;       //回零速度
    int home_low_speed;        //回零低速，一般当有碰到减速信号时才会用到
    int home_find_speed;       //查找零点的速度
    int home_offset;                //原点偏移，回零可以根据该参数再进行一次移动
    int home_space;                 //离开零点需要的至少空间
    long negative_space;            //离开限位需要的至少空间

#ifdef AXIS_PP_TASK_NUMBER
    char cur_task_index;        //当前任务位置
    char task_number;           //任务数
    axis_tasks_data_t tasks[AXIS_PP_TASK_NUMBER];  //任务缓冲池
#endif
    short interp_feed;          //插补位置;
    unsigned short interp_reg;      //插补寄存器值
} axis_object_t;

typedef struct
{
    char index;             //编号，辅助识别用，意义不大
    int posi;               //阶段位置
    unsigned short speed;   //该阶段期望的速度
    //计算变量
    unsigned short dst_speed_index; //目标速查表编号
    unsigned short reg;     //该阶段速度对应的寄存器值
    int decposition;        //减速位置
} axis_stage_task_t;


#if 0
//硬件正极限信号
#define AXIS_HW_POSITIVE_SGN(axis)  axis->inputs.hw_positive_lmt
//硬件负极限信号
#define AXIS_HW_NEGATIVE_SGN(axis)  axis->inputs.hw_negative_lmt
//方向反向信号
#define AXIS_REVERSE_SGN(axis)      axis->inputs.dir_reverse
//软件极限保护使能信号
#define AXIS_SW_PROTECCT_SGN(axis)  axis->inputs.sw_lmt_enable
//减速信号
#define AXIS_SLOW_SGN(axis)         axis->inputs.hw_slow_lmt
//报警信号
#define AXIS_ALARM_SGN(axis)        axis->inputs.alarm_sgn
//回零时使能高速，当有减速信号开关时才使用
#define AXIS_HOMING_HIGH_SPEED_ENABLE(axis) axis->inputs.home_high_speed_enable
#endif

//是否正在回零点
#define AXIS_IS_HOMING(axis) (axis->outputs.homing)
//是否正在自动运行
#define AXIS_IS_RUNNING(axis) (axis->outputs.on)
//是否停止状态
#define AXIS_IS_STOP(axis) (axis->outputs.on == 0)
//是否出现错误
#define AXIS_IS_ERROR(axis) (axis->outputs.error_alarm)
//硬件正极限信号
#define AXIS_EXCEED_HW_POSITIVE(axis)  (axis->outputs.hw_positive_alarm)
//硬件负极限信号
#define AXIS_EXCEED_HW_NEGATIVE(axis)  (axis->outputs.hw_negative_alarm)
//软件正极限信号
#define AXIS_EXCEED_SW_POSITIVE(axis)  (axis->outputs.sw_positive_alarm)
//软件负极限信号
#define AXIS_EXCEED_SW_NEGATIVE(axis)  (axis->outputs.sw_negative_alarm)
//硬件使能信号
#define AXIS_IS_ENABLE(axis)  (axis->outputs.enable)
//硬件清除报警信号
#define AXIS_IS_ERRCLEAR(axis)  (axis->outputs.error_clear)


void axis_run(axis_object_t *axis);

void axis_start(axis_object_t *axis);
void axis_stop(axis_object_t *axis);
void axis_emgstop(axis_object_t *axis);
int axis_pp(axis_object_t *axis, int rel, int position, int speed);
void axis_pv(axis_object_t *axis, int dir, int speed);
void axis_pv_change_speed(axis_object_t *axis, int speed);
void axis_stop_at(axis_object_t *axis, int postion);
void axis_interp(axis_object_t *axis, int position, int period);

void axis_init_pp_task(axis_object_t *axis, int dir);
void axis_add_pp_task(axis_object_t *axis, int feed, int speed);
int axis_start_pp_task(axis_object_t *axis);



void axis_ccw(axis_object_t *axis);
void axis_cw(axis_object_t *axis);

void axis_home_run(axis_object_t *axis);
void axis_home(axis_object_t *axis, int method, int home_speed, int find_speed);
void axis_home_enable_high_speed(axis_object_t *axis, int high_speed);
void axis_home_disable_high_speed(axis_object_t *axis);
void axis_set_home_sgn(axis_object_t *axis, void * reg, unsigned short mask,unsigned short value, char filter);
void axis_set_home_encoder_sgn(axis_object_t *axis, void * reg, unsigned short mask,unsigned short value, char filter);

void axis_stop_all(axis_object_t *axis);

void axis_set_ouput(axis_object_t *axis, axis_output_name type, int value);

void axis_it_handle(void *handle);

int axis_cw_lmt(axis_object_t *axis);
int axis_ccw_lmt(axis_object_t *axis);

int axis_get_error(axis_object_t *axis);
void axis_clear_error(axis_object_t *axis);

void axis_enable(axis_object_t *axis);
void axis_disable(axis_object_t *axis);

void axis_set_parameter(axis_object_t *axis, int cmd, int argv);
int axis_get_parameter(axis_object_t *axis, int cmd);

void axis_set_software_lmt(axis_object_t *axis, int positive, int negative);
void axis_enable_software_lmt(axis_object_t *axis);
void axis_disable_software_lmt(axis_object_t *axis);


void axis_register_irq_callback(axis_object_t *axis, void (*handle)());
void axis_unregister_irq_callback(axis_object_t *axis);

void axis_set_accdec(axis_object_t *axis, int accdec_mode, int acc_time, int dec_time);
void axis_calc_speed_table(axis_object_t *axis, int target_speed);

// void axis_set_ratio(axis_object_t *axis, int cycle_pluse, int cycle_length);
void axis_set_ratio(axis_object_t *axis, int cycle_pluse, int cycle_length,int lenrate);
void axis_enable_ratio(axis_object_t *axis);
void axis_disable_ratio(axis_object_t *axis);

int axis_pluse_to_position(axis_object_t *axis, int value);
int axis_position_to_pluse(axis_object_t *axis, int value);
int axis_revs_to_freq(axis_object_t *axis, int value);
int axis_freq_to_revs(axis_object_t *axis,int value);
int axis_speed_to_freq(axis_object_t *axis, int value);

#endif