projects/microb2010/common/i2c_commands.h

   1 /*
   2  *  Copyright Droids Corporation (2010)
   3  *
   4  *  This program is free software; you can redistribute it and/or modify
   5  *  it under the terms of the GNU General Public License as published by
   6  *  the Free Software Foundation; either version 2 of the License, or
   7  *  (at your option) any later version.
   8  *
   9  *  This program is distributed in the hope that it will be useful,
  10  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  *  GNU General Public License for more details.
  13  *
  14  *  You should have received a copy of the GNU General Public License
  15  *  along with this program; if not, write to the Free Software
  16  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  17  *
  18  *  Revision : $Id: i2c_commands.h,v 1.9 2009-05-27 20:04:06 zer0 Exp $
  19  *
  20  */
  21
  22 #ifndef _I2C_COMMANDS_H_
  23 #define _I2C_COMMANDS_H_
  24
  25 #define I2C_OPPONENT_NOT_THERE -1000
  26
  27 #define I2C_MAINBOARD_ADDR   1
  28 #define I2C_COBBOARD_ADDR    2
  29 #define I2C_BALLBOARD_ADDR   3
  30
  31 #define I2C_LEFT_SIDE    0
  32 #define I2C_RIGHT_SIDE   1
  33 #define I2C_AUTO_SIDE    2
  34 #define I2C_CENTER_SIDE  3
  35 #define I2C_NO_SIDE      4
  36
  37 #define I2C_COLOR_YELLOW 0
  38 #define I2C_COLOR_BLUE   1
  39
  40 #define I2C_COB_BLACK   0
  41 #define I2C_COB_WHITE   1
  42 #define I2C_COB_UNKNOWN 2
  43 #define I2C_COB_REMOVED 3
  44 #define I2C_COB_NONE    4
  45
  46 struct i2c_cmd_hdr {
  47         uint8_t cmd;
  48 };
  49
  50 /****/
  51 /* commands that do not need and answer */
  52 /****/
  53
  54 #define I2C_CMD_GENERIC_LED_CONTROL 0x00
  55
  56 struct i2c_cmd_led_control {
  57         struct i2c_cmd_hdr hdr;
  58         uint8_t led_num:7;
  59         uint8_t state:1;
  60 };
  61
  62 /****/
  63
  64 #define I2C_CMD_GENERIC_SET_COLOR 0x01
  65
  66 struct i2c_cmd_generic_color {
  67         struct i2c_cmd_hdr hdr;
  68         uint8_t color;
  69 };
  70
  71 /****/
  72
  73 #define I2C_CMD_COBBOARD_SET_MODE 0x02
  74
  75 struct i2c_cmd_cobboard_set_mode {
  76         struct i2c_cmd_hdr hdr;
  77
  78 #define I2C_COBBOARD_MODE_HARVEST      0x01 /* harvest mode */
  79 #define I2C_COBBOARD_MODE_EJECT        0x02 /* eject cobs */
  80 #define I2C_COBBOARD_MODE_INIT         0x03 /* init state machine */
  81 #define I2C_COBBOARD_MODE_KICKSTAND_UP   0x04 /* help to climb the hill */
  82 #define I2C_COBBOARD_MODE_KICKSTAND_DOWN 0x05 /* help to climb the hill */
  83         uint8_t mode;
  84 };
  85
  86 #define I2C_CMD_BALLBOARD_SET_MODE 0x10
  87
  88 struct i2c_cmd_ballboard_set_mode {
  89         struct i2c_cmd_hdr hdr;
  90
  91 #define I2C_BALLBOARD_MODE_INIT        0x00
  92 #define I2C_BALLBOARD_MODE_OFF         0x01
  93 #define I2C_BALLBOARD_MODE_HARVEST     0x02
  94 #define I2C_BALLBOARD_MODE_EJECT       0x03
  95 #define I2C_BALLBOARD_MODE_PREP_FORK   0x04
  96 #define I2C_BALLBOARD_MODE_TAKE_FORK   0x05
  97         uint8_t mode;
  98 };
  99
 100 /****/
 101 /* requests and their answers */
 102 /****/
 103
 104
 105 #define I2C_REQ_COBBOARD_STATUS 0x80
 106
 107 struct i2c_req_cobboard_status {
 108         struct i2c_cmd_hdr hdr;
 109
 110 #define I2C_COBBOARD_SPK_DEPLOY  0x01 /* deploy the spickle */
 111 #define I2C_COBBOARD_SPK_AUTOHARVEST 0x02 /* auto harvest the cobs */
 112 #define I2C_COBBOARD_SPK_NO_MOVE 0x04 /* if enabled, don't change state */
 113 #define I2C_COBBOARD_SPK_WEAK 0x08 /* if enabled, current limit */
 114         uint8_t lspickle;
 115         uint8_t rspickle;
 116 };
 117
 118 #define I2C_ANS_COBBOARD_STATUS 0x81
 119
 120 struct i2c_ans_cobboard_status {
 121         struct i2c_cmd_hdr hdr;
 122
 123         /* mode type are defined above: I2C_COBBOARD_MODE_xxx */
 124         uint8_t mode;
 125
 126 #define I2C_COBBOARD_STATUS_READY          0x00
 127 #define I2C_COBBOARD_STATUS_OFF            0x01
 128 #define I2C_COBBOARD_STATUS_LBUSY          0x02
 129 #define I2C_COBBOARD_STATUS_RBUSY          0x03
 130 #define I2C_COBBOARD_STATUS_EJECT          0x04
 131 #define I2C_COBBOARD_STATUS_KICKSTAND_UP   0x05
 132 #define I2C_COBBOARD_STATUS_KICKSTAND_DOWN 0x06
 133         uint8_t status;
 134
 135         uint8_t cob_count;
 136
 137         int16_t left_cobroller_speed;
 138         int16_t right_cobroller_speed;
 139 };
 140
 141 #define I2C_REQ_BALLBOARD_STATUS 0x82
 142
 143 struct i2c_req_ballboard_status {
 144         struct i2c_cmd_hdr hdr;
 145 };
 146
 147 #define I2C_ANS_BALLBOARD_STATUS 0x83
 148
 149 struct i2c_ans_ballboard_status {
 150         struct i2c_cmd_hdr hdr;
 151
 152         uint8_t mode;
 153
 154 #define I2C_BALLBOARD_STATUS_F_READY         0x00
 155 #define I2C_BALLBOARD_STATUS_F_BUSY          0x01
 156 #define I2C_BALLBOARD_STATUS_F_EXCPT         0x02
 157         uint8_t status;
 158
 159         uint8_t ball_count;
 160
 161         /* detection of cobs */
 162         uint8_t lcob;
 163         uint8_t rcob;
 164 };
 165
 166 #endif /* _I2C_PROTOCOL_H_ */