bertos/drv/dc_motor.h

   1 /**
   2  * \file
   3  * <!--
   4  * This file is part of BeRTOS.
   5  *
   6  * Bertos is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  19  *
  20  * As a special exception, you may use this file as part of a free software
  21  * library without restriction.  Specifically, if other files instantiate
  22  * templates or use macros or inline functions from this file, or you compile
  23  * this file and link it with other files to produce an executable, this
  24  * file does not by itself cause the resulting executable to be covered by
  25  * the GNU General Public License.  This exception does not however
  26  * invalidate any other reasons why the executable file might be covered by
  27  * the GNU General Public License.
  28  *
  29  * Copyright 2008 Develer S.r.l. (http://www.develer.com/)
  30  * -->
  31  *
  32  *
  33  * \brief DC motor driver.
  34  *
  35  * \author Daniele Basile <asterix@develer.com>
  36  *
  37  * $WIZ$ module_name = "dc_motor"
  38  * $WIZ$ module_depends = "pwm", "pid_control", "adc", "timer"
  39  * $WIZ$ module_configuration = "bertos/cfg/cfg_dc_motor.h"
  40  * $WIZ$ module_hw = "bertos/hw/hw_dc_motor.h"
  41  */
  42
  43 #ifndef DRV_DC_MOTOR_H
  44 #define DRV_DC_MOTOR_H
  45
  46 #include "hw/hw_dc_motor.h"
  47
  48 #include "cfg/cfg_dc_motor.h"
  49 #include <cfg/macros.h>
  50
  51 #include <algo/pid_control.h>
  52
  53 #include <drv/pwm.h>
  54 #include <drv/timer.h>
  55 #include <drv/adc.h>
  56
  57 #define DC_MOTOR_NO_EXPIRE        -1  ///< The DC motor runs do not expire, so it runs forever.
  58 #define DC_MOTOR_NO_DEV_SPEED     -1  ///< Disable the speed acquire from device (like trimmer, etc.).
  59
  60 /**
  61  * Type for DC motor.
  62  */
  63 typedef uint16_t dc_speed_t;
  64
  65 /**
  66  * DC motor configuration stucture
  67  */
  68 typedef struct DCMotorConfig
  69 {
  70         PidCfg pid_cfg;         ///< Pid control.
  71         bool pid_enable;        ///< Flag to disable or enable pid control.
  72
  73         PwmDev pwm_dev;         ///< Pwm channel.
  74         pwm_freq_t freq;        ///< Pwm waveform frequency.
  75
  76         adc_ch_t adc_ch;        ///< ADC channel.
  77         adcread_t adc_max;      ///< ADC max scale value.
  78         adcread_t adc_min;      ///< ADC min scale value.
  79
  80         bool dir;               ///< Default direction for select DC motor.
  81         bool braked;            ///< If true the motor is braked when we turn off it.
  82
  83         dc_speed_t speed;       ///< Default speed value for select DC motor.
  84
  85         int speed_dev_id;       ///<  Index of the device where read speed, to disable set to DC_MOTOR_NO_DEV_SPEED.
  86
  87 } DCMotorConfig;
  88
  89
  90 /**
  91  * Context structure for DC motor.
  92  */
  93 typedef struct DCMotor
  94 {
  95         const DCMotorConfig *cfg; ///< All configuration for select DC motor.
  96         PidContext pid_ctx;       ///< Pid control.
  97
  98         int index;                ///< DC motor id.
  99         uint32_t status;          ///< Status of select DC motor
 100         dc_speed_t tgt_speed;     ///< Target speed for select DC motor
 101
 102         ticks_t expire_time;      ///< Amount of time that  dc motor run
 103
 104 } DCMotor;
 105
 106 void dc_motor_setDir(int index, bool dir);
 107 void dc_motor_enable(int index, bool state);
 108 void dc_motor_setSpeed(int index, dc_speed_t speed);
 109 void dc_motor_startTimer(int index, mtime_t on_time);
 110 void dc_motor_waitStop(int index);
 111 void dc_motor_setup(int index, DCMotorConfig *dcm_conf);
 112 dc_speed_t dc_motor_readTargetSpeed(int index);
 113 void dc_motor_setPriority(int priority);
 114 void dc_motor_init(void);
 115
 116
 117 /**
 118  * Test function prototypes.
 119  *
 120  * See dc_motor_hwtest.c file.
 121  */
 122 int dc_motor_testSetUp(void);
 123 void dc_motor_testRun(void);
 124 int dc_motor_testTearDown(void);
 125
 126 #endif /* DRV_DC_MOTOR_H */