stepper_at91.c

Go to the documentation of this file.

#include "stepper_at91.h"

#include "cfg/cfg_stepper.h"
#include <cfg/macros.h>
#include <cfg/debug.h>

#include <cpu/types.h>
#include <cpu/irq.h>

#include <io/arm.h>


/*
 * Delay to set C compare to clear output
 * on select TIO output
 */
#define STEPPER_DELAY_ON_COMPARE_C 20

/*
 * Forward declaration for interrupt handler
 */
static void stepper_tc0_irq(void);
static void stepper_tc1_irq(void);
static void stepper_tc2_irq(void);

static struct TimerCounter stepper_timers[CONFIG_TC_STEPPER_MAX_NUM] =
{
    { //Timer Counter settings for TIOA0 output pin
        .timer_id = TC0_ID,
        .blk_ctrl_set = TC_NONEXC0,
        .chl_mode_reg = &TC0_CMR,
        .chl_ctrl_reg = &TC0_CCR,
        .comp_effect_mask = TC_ACPA_MASK,
        .comp_effect_set = TC_ACPA_SET_OUTPUT,
        .comp_effect_clear = TC_ACPA_CLEAR_OUTPUT,
        .comp_effect_c_mask = TC_ACPC_MASK,
        .comp_effect_c_clear = TC_ACPC_CLEAR_OUTPUT,
        .ext_event_set = TC_EEVT_XC0,
        .comp_reg = &TC0_RA,
        .comp_c_reg = &TC0_RC,
        .count_val_reg = &TC0_CV,
        .irq_enable_reg = &TC0_IER,
        .irq_disable_reg = &TC0_IDR,
        .irq_set_mask = BV(TC_CPAS),
        .irq_mask_reg = &TC0_IMR,
        .isr = stepper_tc0_irq,
        .status_reg = &TC0_SR,
        .tio_pin = TIOA0,
        .callback = NULL,
        .motor = NULL,
    },
    { //Timer Counter settings for TIOB0 output pin
        .timer_id = TC0_ID,
        .blk_ctrl_set = TC_NONEXC0,
        .chl_mode_reg = &TC0_CMR,
        .chl_ctrl_reg = &TC0_CCR,
        .comp_reg = &TC0_RB,
        .comp_c_reg = &TC0_RC,
        .count_val_reg = &TC0_CV,
        .comp_effect_mask = TC_BCPB_MASK,
        .comp_effect_set = TC_BCPB_SET_OUTPUT,
        .comp_effect_clear = TC_BCPB_CLEAR_OUTPUT,
        .comp_effect_c_mask = TC_BCPC_MASK,
        .comp_effect_c_clear = TC_BCPC_CLEAR_OUTPUT,
        .ext_event_set = TC_EEVT_XC0,
        .irq_enable_reg = &TC0_IER,
        .irq_disable_reg = &TC0_IDR,
        .irq_set_mask = BV(TC_CPBS),
        .irq_mask_reg = &TC0_IMR,
        .isr = stepper_tc0_irq,
        .status_reg = &TC0_SR,
        .tio_pin = TIOB0,
        .callback = NULL,
        .motor = NULL,
    },
    { //Timer Counter settings for TIOA1 output pin
        .timer_id = TC1_ID,
        .blk_ctrl_set = TC_NONEXC1,
        .chl_mode_reg = &TC1_CMR,
        .chl_ctrl_reg = &TC1_CCR,
        .comp_reg = &TC1_RA,
        .comp_c_reg = &TC1_RC,
        .count_val_reg = &TC1_CV,
        .comp_effect_mask = TC_ACPA_MASK,
        .comp_effect_set = TC_ACPA_SET_OUTPUT,
        .comp_effect_clear = TC_ACPA_CLEAR_OUTPUT,
        .comp_effect_c_mask = TC_ACPC_MASK,
        .comp_effect_c_clear = TC_ACPC_CLEAR_OUTPUT,
        .ext_event_set = TC_EEVT_XC1,
        .irq_enable_reg = &TC1_IER,
        .irq_disable_reg = &TC1_IDR,
        .irq_set_mask = BV(TC_CPAS),
        .irq_mask_reg = &TC1_IMR,
        .isr = stepper_tc1_irq,
        .status_reg = &TC1_SR,
        .tio_pin = TIOA1,
        .callback = NULL,
        .motor = NULL,
    },
    { //Timer Counter settings for TIOB1 output pin
        .timer_id = TC1_ID,
        .blk_ctrl_set = TC_NONEXC1,
        .chl_mode_reg = &TC1_CMR,
        .chl_ctrl_reg = &TC1_CCR,
        .comp_reg = &TC1_RB,
        .comp_c_reg = &TC1_RC,
        .count_val_reg = &TC1_CV,
        .comp_effect_mask = TC_BCPB_MASK,
        .comp_effect_set = TC_BCPB_SET_OUTPUT,
        .comp_effect_clear = TC_BCPB_CLEAR_OUTPUT,
        .comp_effect_c_mask = TC_BCPC_MASK,
        .comp_effect_c_clear = TC_BCPC_CLEAR_OUTPUT,
        .ext_event_set = TC_EEVT_XC1,
        .irq_enable_reg = &TC1_IER,
        .irq_disable_reg = &TC1_IDR,
        .irq_set_mask = BV(TC_CPBS),
        .irq_mask_reg = &TC1_IMR,
        .isr = stepper_tc1_irq,
        .status_reg = &TC1_SR,
        .tio_pin = TIOB1,
        .callback = NULL,
        .motor = NULL,
    },
    { //Timer Counter settings for TIOA2 output pin
        .timer_id = TC2_ID,
        .blk_ctrl_set = TC_NONEXC2,
        .chl_mode_reg = &TC2_CMR,
        .chl_ctrl_reg = &TC2_CCR,
        .comp_reg = &TC2_RA,
        .comp_c_reg = &TC2_RC,
        .count_val_reg = &TC2_CV,
        .comp_effect_mask = TC_ACPA_MASK,
        .comp_effect_set = TC_ACPA_SET_OUTPUT,
        .comp_effect_clear = TC_ACPA_CLEAR_OUTPUT,
        .comp_effect_c_mask = TC_ACPC_MASK,
        .comp_effect_c_clear = TC_ACPC_CLEAR_OUTPUT,
        .ext_event_set = TC_EEVT_XC2,
        .irq_enable_reg = &TC2_IER,
        .irq_disable_reg = &TC2_IDR,
        .irq_set_mask = BV(TC_CPAS),
        .irq_mask_reg = &TC2_IMR,
        .isr = stepper_tc2_irq,
        .status_reg = &TC2_SR,
        .tio_pin = TIOA2,
        .callback = NULL,
        .motor = NULL,
    },
    { //Timer Counter settings for TIOB2 output pin
        .timer_id = TC2_ID,
        .blk_ctrl_set = TC_NONEXC2,
        .chl_mode_reg = &TC2_CMR,
        .chl_ctrl_reg = &TC2_CCR,
        .comp_reg = &TC2_RB,
        .comp_c_reg = &TC2_RC,
        .count_val_reg = &TC2_CV,
        .comp_effect_mask = TC_BCPB_MASK,
        .comp_effect_set = TC_BCPB_SET_OUTPUT,
        .comp_effect_clear = TC_BCPB_CLEAR_OUTPUT,
        .comp_effect_c_mask = TC_BCPC_MASK,
        .comp_effect_c_clear = TC_BCPC_CLEAR_OUTPUT,
        .ext_event_set = TC_EEVT_XC2,
        .irq_enable_reg = &TC2_IER,
        .irq_disable_reg = &TC2_IDR,
        .irq_set_mask = BV(TC_CPBS),
        .irq_mask_reg = &TC2_IMR,
        .isr = stepper_tc2_irq,
        .status_reg = &TC2_SR,
        .tio_pin = TIOB2,
        .callback = NULL,
        .motor = NULL,
    }
};

INLINE void stepper_tc_tio_irq(struct TimerCounter * t)
{
    //
    *t->chl_mode_reg &= ~t->comp_effect_c_mask;
    *t->chl_mode_reg |= t->comp_effect_c_clear;

    /*
     * Cleat TIO output on c register compare.
     * This generate an pulse with variable lenght, this
     * depend to delay that interrupt is realy service.
     */
    *t->comp_c_reg = *t->count_val_reg + STEPPER_DELAY_ON_COMPARE_C;

    //Call the associate callback
    t->callback(t->motor);

    *t->chl_mode_reg &= ~t->comp_effect_c_mask;
}


/*
 * Interrupt handler for timer counter TCKL0
 */
static void ISR_FUNC stepper_tc0_irq(void)
{
    /*
     * Warning: when we read the status_reg register, we reset it.
     * That mean if is occur an interrupt event we can read only
     * the last that has been occur. To not miss an interrupt event
     * we save the status_reg register and then we read it.
     */
    uint32_t  status_reg = TC0_SR & TC0_IMR;

    if (status_reg & BV(TC_CPAS))
        stepper_tc_tio_irq(&stepper_timers[TC_TIOA0]);

    if (status_reg & BV(TC_CPBS))
        stepper_tc_tio_irq(&stepper_timers[TC_TIOB0]);

    /* Inform hw that we have served the IRQ */
    AIC_EOICR = 0;

}

/*
 * Interrupt handler for timer counter TCKL1
 */
static void ISR_FUNC stepper_tc1_irq(void)
{
    /*
     * Warning: when we read the status_reg register, we reset it.
     * That mean if is occur an interrupt event we can read only
     * the last that has been occur. To not miss an interrupt event
     * we save the status_reg register and then we read it.
     */
    uint32_t  status_reg = TC1_SR & TC1_IMR;

    if (status_reg & BV(TC_CPAS))
        stepper_tc_tio_irq(&stepper_timers[TC_TIOA1]);

    if (status_reg & BV(TC_CPBS))
        stepper_tc_tio_irq(&stepper_timers[TC_TIOB1]);


    /* Inform hw that we have served the IRQ */
    AIC_EOICR = 0;
}


/*
 * Interrupt handler for timer counter TCKL2
 */
static void ISR_FUNC stepper_tc2_irq(void)
{

    /*
     * Warning: when we read the status_reg register, we reset it.
     * That mean if is occur an interrupt event we can read only
     * the last that has been occur. To not miss an interrupt event
     * we save the status_reg register and then we read it.
     */
    uint32_t  status_reg = TC2_SR & TC2_IMR;

    if (status_reg & BV(TC_CPAS))
        stepper_tc_tio_irq(&stepper_timers[TC_TIOA2]);

    if (status_reg & BV(TC_CPBS))
        stepper_tc_tio_irq(&stepper_timers[TC_TIOB2]);

    /* Inform hw that we have served the IRQ */
    AIC_EOICR = 0;

}

void stepper_tc_setup(int index, stepper_isr_t callback, struct Stepper *motor)
{
    ASSERT(index < CONFIG_TC_STEPPER_MAX_NUM);

    motor->timer = &stepper_timers[index];

    //Disable PIO controller and enable TIO function
    TIO_PIO_PDR = BV(motor->timer->tio_pin);
    TIO_PIO_ABSR = BV(motor->timer->tio_pin);

    /*
     * Sets timer counter in waveform mode.
     * We set as default:
     * - Waveform mode 00 (see datasheet for more detail.)
     * - Master clock prescaler to STEPPER_MCK_PRESCALER
     * - Set none external event
     * - Clear pin output on comp_reg
     * - None effect on reg C compare
     */
    *motor->timer->chl_mode_reg = BV(TC_WAVE);
    *motor->timer->chl_mode_reg |= motor->timer->ext_event_set;
    *motor->timer->chl_mode_reg &= ~TC_WAVSEL_MASK;
    *motor->timer->chl_mode_reg |= TC_WAVSEL_UP;
    *motor->timer->chl_mode_reg |= STEPPER_MCK_PRESCALER;
    *motor->timer->chl_mode_reg |= motor->timer->comp_effect_clear;
    *motor->timer->chl_mode_reg &= ~motor->timer->comp_effect_c_mask;

    //Reset comp_reg and C compare register
    *motor->timer->comp_reg = 0;
    *motor->timer->comp_c_reg = 0;

    //Register interrupt vector
    cpu_flags_t flags;
    IRQ_SAVE_DISABLE(flags);

    /*
     * Warning: To guarantee a correct management of interrupt event, we must
     * trig the interrupt on level sensitive. This becouse, we have only a common
     * line for interrupt request, and if we have at the same time two interrupt
     * request could be that the is service normaly but the second will never
     *  been detected and interrupt will stay active but never serviced.
     */
    AIC_SVR(motor->timer->timer_id) = motor->timer->isr;
    AIC_SMR(motor->timer->timer_id) = AIC_SRCTYPE_INT_LEVEL_SENSITIVE;
    AIC_IECR = BV(motor->timer->timer_id);

    // Disable interrupt on select timer counter
    stepper_tc_irq_disable(motor->timer);

    IRQ_RESTORE(flags);

    //Register callback
    motor->timer->callback = callback;
    motor->timer->motor = motor;
}

void stepper_tc_init(void)
{
    STEPPER_STROBE_INIT;

    ASSERT(CONFIG_NUM_STEPPER_MOTORS <= CONFIG_TC_STEPPER_MAX_NUM);

    /*
     * Enable timer counter:
     * - power on all timer counter
     * - disable all interrupt
     * - disable all external event/timer source
     */
    for (int i = 0; i < CONFIG_TC_STEPPER_MAX_NUM; i++)
    {
        PMC_PCER = BV(stepper_timers[i].timer_id);
        *stepper_timers[i].irq_disable_reg = 0xFFFFFFFF;
        TC_BMR = stepper_timers[i].blk_ctrl_set;
    }

    /*
     * Enable timer counter and start it.
     */
    for (int i = 0; i < CONFIG_TC_STEPPER_MAX_NUM; i++)
        *stepper_timers[i].chl_ctrl_reg = (BV(TC_CLKEN) | BV(TC_SWTRG));

}