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 #define I2C_BEACON_NOT_FOUND -1000
  27
  28 #define I2C_MAINBOARD_ADDR   1
  29 #define I2C_COBBOARD_ADDR    2
  30 #define I2C_BALLBOARD_ADDR   3
  31
  32 #define I2C_LEFT_SIDE    0
  33 #define I2C_RIGHT_SIDE   1
  34 #define I2C_AUTO_SIDE    2
  35 #define I2C_CENTER_SIDE  3
  36 #define I2C_NO_SIDE      4
  37
  38 #define I2C_COLOR_YELLOW 0
  39 #define I2C_COLOR_BLUE   1
  40
  41 #define I2C_COB_BLACK   0
  42 #define I2C_COB_WHITE   1
  43 #define I2C_COB_UNKNOWN 2
  44 #define I2C_COB_REMOVED 3
  45 #define I2C_COB_NONE    4
  46
  47 struct i2c_cmd_hdr {
  48         uint8_t cmd;
  49 };
  50
  51 /****/
  52 /* commands that do not need and answer */
  53 /****/
  54
  55 #define I2C_CMD_GENERIC_LED_CONTROL 0x00
  56
  57 struct i2c_cmd_led_control {
  58         struct i2c_cmd_hdr hdr;
  59         uint8_t led_num:7;
  60         uint8_t state:1;
  61 };
  62
  63 /****/
  64
  65 #define I2C_CMD_GENERIC_SET_COLOR 0x01
  66
  67 struct i2c_cmd_generic_color {
  68         struct i2c_cmd_hdr hdr;
  69         uint8_t color;
  70 };
  71
  72 /****/
  73
  74 #define I2C_CMD_COBBOARD_SET_MODE 0x02
  75
  76 struct i2c_cmd_cobboard_set_mode {
  77         struct i2c_cmd_hdr hdr;
  78
  79 #define I2C_COBBOARD_MODE_HARVEST      0x01 /* harvest mode */
  80 #define I2C_COBBOARD_MODE_EJECT        0x02 /* eject cobs */
  81 #define I2C_COBBOARD_MODE_INIT         0x03 /* init state machine */
  82 #define I2C_COBBOARD_MODE_KICKSTAND_UP   0x04 /* help to climb the hill */
  83 #define I2C_COBBOARD_MODE_KICKSTAND_DOWN 0x05 /* help to climb the hill */
  84         uint8_t mode;
  85 };
  86
  87 #define I2C_CMD_BALLBOARD_SET_MODE 0x10
  88
  89 struct i2c_cmd_ballboard_set_mode {
  90         struct i2c_cmd_hdr hdr;
  91
  92 #define I2C_BALLBOARD_MODE_INIT        0x00
  93 #define I2C_BALLBOARD_MODE_OFF         0x01
  94 #define I2C_BALLBOARD_MODE_HARVEST     0x02
  95 #define I2C_BALLBOARD_MODE_EJECT       0x03
  96 #define I2C_BALLBOARD_MODE_PREP_FORK   0x04
  97 #define I2C_BALLBOARD_MODE_TAKE_FORK   0x05
  98         uint8_t mode;
  99 };
 100
 101 #define I2C_CMD_BALLBOARD_SET_BEACON 0x04
 102
 103 struct i2c_cmd_ballboard_start_beacon {
 104         struct i2c_cmd_hdr hdr;
 105         uint8_t enable;
 106 };
 107
 108 /****/
 109 /* requests and their answers */
 110 /****/
 111
 112
 113 #define I2C_REQ_COBBOARD_STATUS 0x80
 114
 115 struct i2c_req_cobboard_status {
 116         struct i2c_cmd_hdr hdr;
 117
 118 #define I2C_COBBOARD_SPK_DEPLOY  0x01 /* deploy the spickle */
 119 #define I2C_COBBOARD_SPK_AUTOHARVEST 0x02 /* auto harvest the cobs */
 120 #define I2C_COBBOARD_SPK_NO_MOVE 0x04 /* if enabled, don't change state */
 121 #define I2C_COBBOARD_SPK_WEAK 0x08 /* if enabled, current limit */
 122         uint8_t lspickle;
 123         uint8_t rspickle;
 124 };
 125
 126 #define I2C_ANS_COBBOARD_STATUS 0x81
 127
 128 struct i2c_ans_cobboard_status {
 129         struct i2c_cmd_hdr hdr;
 130
 131         /* mode type are defined above: I2C_COBBOARD_MODE_xxx */
 132         uint8_t mode;
 133
 134 #define I2C_COBBOARD_STATUS_READY          0x00
 135 #define I2C_COBBOARD_STATUS_OFF            0x01
 136 #define I2C_COBBOARD_STATUS_LBUSY          0x02
 137 #define I2C_COBBOARD_STATUS_RBUSY          0x03
 138 #define I2C_COBBOARD_STATUS_EJECT          0x04
 139 #define I2C_COBBOARD_STATUS_KICKSTAND_UP   0x05
 140 #define I2C_COBBOARD_STATUS_KICKSTAND_DOWN 0x06
 141         uint8_t status;
 142
 143         uint8_t cob_count;
 144
 145         int16_t left_cobroller_speed;
 146         int16_t right_cobroller_speed;
 147 };
 148
 149 #define I2C_REQ_BALLBOARD_STATUS 0x82
 150
 151 struct i2c_req_ballboard_status {
 152         struct i2c_cmd_hdr hdr;
 153
 154         /* position sent by mainboard */
 155         int16_t x;
 156         int16_t y;
 157         int16_t a;
 158 };
 159
 160 #define I2C_ANS_BALLBOARD_STATUS 0x83
 161
 162 struct i2c_ans_ballboard_status {
 163         struct i2c_cmd_hdr hdr;
 164
 165         uint8_t mode;
 166
 167 #define I2C_BALLBOARD_STATUS_F_READY         0x00
 168 #define I2C_BALLBOARD_STATUS_F_BUSY          0x01
 169 #define I2C_BALLBOARD_STATUS_F_EXCPT         0x02
 170         uint8_t status;
 171
 172         int16_t opponent_x;
 173         int16_t opponent_y;
 174         int16_t opponent_a;
 175         int16_t opponent_d;
 176
 177         uint8_t ball_count;
 178
 179         /* detection of cobs */
 180         uint8_t lcob;
 181         uint8_t rcob;
 182 };
 183
 184 #endif /* _I2C_PROTOCOL_H_ */