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  * \version $Id$
  36  *
  37  * \author Daniele Basile <asterix@develer.com>
  38  *
  39  * $WIZ$ module_name = "dc_motor"
  40  * $WIZ$ module_depends = "pwm", "pid_control", "adc", "timer"
  41  * $WIZ$ module_configuration = "bertos/cfg/cfg_dc_motor.h"
  42  * $WIZ$ module_hw = "bertos/hw/hw_dc_motor.h"
  43  */
  44
  45 #ifndef DRV_DC_MOTOR_H
  46 #define DRV_DC_MOTOR_H
  47
  48 #include "hw/hw_dc_motor.h"
  49
  50 #include "cfg/cfg_dc_motor.h"
  51 #include <cfg/macros.h>
  52
  53 #include <algo/pid_control.h>
  54
  55 #include <drv/pwm.h>
  56 #include <drv/timer.h>
  57 #include <drv/adc.h>
  58
  59
  60 /**
  61  * Define status bit for DC motor device.
  62  */
  63 #define DC_MOTOR_ACTIVE     BV(0)     ///< DC motor enable or disable flag.
  64 #define DC_MOTOR_DIR        BV(1)     ///< Spin direction of DC motor.
  65
  66 /**
  67  * Type for DC motor.
  68  */
  69 typedef uint16_t dc_speed_t;
  70
  71 /**
  72  * DC motor configuration stucture
  73  */
  74 typedef struct DCMotorConfig
  75 {
  76         PidCfg pid_cfg;         ///< Pid control.
  77
  78         PwmDev pwm_dev;         ///< Pwm channel.
  79         pwm_freq_t freq;        ///< Pwm waveform frequency.
  80         bool pol;               ///< Pwm waveform polarity.
  81
  82         adc_ch_t adc_ch;        ///< ADC channel.
  83         adcread_t adc_max;      ///< ADC max scale value.
  84         adcread_t adc_min;      ///< ADC min scale value.
  85         mtime_t sample_delay;   ///< Delay before to sampling.
  86
  87         bool dir;               ///< Default direction for select DC motor.
  88         int speed_trm_id;       ///< Index of trimmer to set speed.
  89         dc_speed_t speed;       ///< Default speed value for select DC motor.
  90
  91 } DCMotorConfig;
  92
  93
  94 /**
  95  * Context structure for DC motor.
  96  */
  97 typedef struct DCMotor
  98 {
  99         const DCMotorConfig *cfg; ///< All configuration for select DC motor.
 100         PidContext pid_ctx;       ///< Pid control.
 101
 102         int index;                ///< DC motor id.
 103         uint32_t status;          ///< Status of select DC motor
 104         dc_speed_t tgt_speed;     ///< Target speed for select DC motor
 105
 106 } DCMotor;
 107
 108 void dc_motor_setDir(int index, bool dir);
 109 void dc_motor_enable(int index, bool state);
 110 void dc_motor_setSpeed(int index, dc_speed_t speed);
 111 void dc_motor_setup(int index, DCMotorConfig *cfg);
 112 void dc_motor_init(void);
 113
 114 #endif /* DRV_DC_MOTOR_H */