dc_motor.c

Go to the documentation of this file.

#include "dc_motor.h"
#include "hw/hw_dc_motor.h"

// Define logging setting (for cfg/log.h module).
#define LOG_LEVEL         DC_MOTOR_LOG_LEVEL
#define LOG_VERBOSITY     DC_MOTOR_LOG_FORMAT

#include <cfg/log.h>
#include <cfg/debug.h>

#include <algo/pid_control.h>

#include <drv/timer.h>
#include <drv/adc.h>

#include <kern/proc.h>

#include <string.h>

static DCMotor dcm_all[CONFIG_NUM_DC_MOTOR];

static cpu_stack_t dc_motor_poll_stack[1024];

static mtime_t sample_period;

// Only for Debug
LOG_INFOB(static int debug_msg_delay = 0;);

//Forward declaration
static void dc_motor_do(int index);

static void NORETURN dc_motor_poll(void)
{
    for (;;)
    {
        mtime_t max_sample_delay = 0;
        int i;

        /*
         * For all DC motor we read and process output singal,
         * and choose the max value to off time
         */
        for (i = 0; i < CONFIG_NUM_DC_MOTOR; i++)
        {
            dc_motor_do(i);
            max_sample_delay = MAX(max_sample_delay, dcm_all[i].cfg->sample_delay);
        }

        //Wait for next sampling
        timer_delay(sample_period - max_sample_delay);

        for (i = 0; i < CONFIG_NUM_DC_MOTOR; i++)
        {
            if (dcm_all[i].status & DC_MOTOR_ACTIVE)
            {
                DC_MOTOR_DISABLE(dcm_all[i].index);
                pwm_enable(dcm_all[i].cfg->pwm_dev, false);
            }
        }

        //Wait some time to allow signal to stabilize before sampling
        timer_delay(max_sample_delay);
    }
}

/*
 * Sampling a signal on DC motor and compute
 * a new value of speed according with PID control.
 */
static void dc_motor_do(int index)
{
    DCMotor *dcm = &dcm_all[index];

    dc_speed_t curr_pos;
    pwm_duty_t new_pid;

    //If select DC motor is not active we return
    if (!(dcm->status & DC_MOTOR_ACTIVE))
        return;

    //Acquire the output signal
    curr_pos = ADC_RANGECONV(adc_read(dcm->cfg->adc_ch), dcm->cfg->adc_min, dcm->cfg->adc_max);

    //Compute next value for reaching target speed from current position
    new_pid = pid_control_update(&dcm->pid_ctx, dcm->tgt_speed, curr_pos);


    LOG_INFOB(if (debug_msg_delay == 20)
    {
        LOG_INFO("DCmt[%d]>curr_speed[%d],tgt[%d]\n", dcm->index, curr_pos, dcm->tgt_speed);
        LOG_INFO("%d,", curr_pos);
        debug_msg_delay = 0;
    }
    debug_msg_delay++;
    kputs("\n"););

    LOG_WARN("tg[%d], new_pid[%d], pos[%d]\n", dcm->tgt_speed, new_pid, curr_pos);

    //Apply the compute duty value
    pwm_setDuty(dcm->cfg->pwm_dev, new_pid);

    //Restart dc motor
    pwm_enable(dcm->cfg->pwm_dev, true);

    DC_MOTOR_ENABLE(dcm->index);
}

void dc_motor_setDir(int index, bool dir)
{
    DCMotor *dcm = &dcm_all[index];

    if (dir != (dcm->status & DC_MOTOR_DIR))
    {
        //Reset previous direction flag, and set new
        dcm->status &= ~DC_MOTOR_DIR;
        dcm->status |= DC_MOTOR_DIR;

        /*
         * To set dc motor direction we must also set the
         * PWM polarity according with dc motor driver chip
         */
        pwm_setPolarity(dcm->cfg->pwm_dev, dir);
        DC_MOTOR_SET_DIR(index, dir);
    }
}


void dc_motor_setSpeed(int index, dc_speed_t speed)
{
    dcm_all[index].tgt_speed = speed;
}

void dc_motor_enable(int index, bool state)
{
    DCMotor *dcm = &dcm_all[index];

    /*
     * Clean all PID stutus variable, becouse
     * we start with new one.
     */
    pid_control_reset(&dcm->pid_ctx);

    if (state)
    {
        dcm->status |= DC_MOTOR_ACTIVE;
    }
    else
    {
        pwm_enable(dcm->cfg->pwm_dev, false);
        DC_MOTOR_DISABLE(dcm->index);

        dcm->status &= ~DC_MOTOR_ACTIVE;
    }
}

void dc_motor_setup(int index, DCMotorConfig *dcm_conf)
{
    DCMotor *dcm = &dcm_all[index];

    dcm->cfg = dcm_conf;

    /*
     * Apply config value.
     */
    dcm->index = index;

    pwm_setFrequency(dcm->cfg->pwm_dev, dcm->cfg->freq);
    pwm_setPolarity(dcm->cfg->pwm_dev, dcm->cfg->pol);
    pwm_enable(dcm->cfg->pwm_dev, false);

    //Init pid control
    pid_control_init(&dcm->pid_ctx, &dcm->cfg->pid_cfg);

    /*
     * We are using the same sample period for each
     * motor, and so we check if this value is the same
     * for all. The sample period time is defined in pid
     * configuration.
     *
     * TODO: Use a different sample period for each motor
     * and refactor a module to allow to use a timer interrupt,
     * in this way we can controll a DC motor also without a
     * kernel, increasing a portability on other target.
     */
    if (!sample_period)
        sample_period = dcm->cfg->pid_cfg.sample_period;

    ASSERT(sample_period == dcm->cfg->pid_cfg.sample_period);

    //Set default direction for DC motor
    DC_MOTOR_SET_DIR(dcm->index, dcm->cfg->dir);

    LOG_INFO("DC motort[%d]:\n", dcm->index);
    LOG_INFO("> PID: kp[%lf],ki[%lf],kd[%lf]\n", dcm->cfg->pid_cfg.kd, dcm->cfg->pid_cfg.ki, dcm->cfg->pid_cfg.kd);
    LOG_INFO("> PWM: pwm_dev[%d], freq[%ld], sample[%ld]\n", dcm->cfg->pwm_dev, dcm->cfg->freq, dcm->cfg->sample_delay);
    LOG_INFO("> ADC: adc_ch[%d], adc_max[%d], adc_min[%d]\n", dcm->cfg->adc_ch, dcm->cfg->adc_max, dcm->cfg->adc_min);
    LOG_INFO("> DC: dir[%d], speed[%d]\n", dcm->cfg->dir, dcm->cfg->speed);

}


void dc_motor_init(void)
{
    memset(dcm_all, 0, sizeof(dcm_all));

    //Init a sample period
    sample_period = 0;

    MOTOR_DC_INIT();

    //Create a dc motor poll process
    proc_new(dc_motor_poll, NULL, sizeof(dc_motor_poll_stack), dc_motor_poll_stack);

}