projects/microb2010/common/i2c_commands.h

   1 /*
   2  *  Copyright Droids Corporation (2007)
   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
  36 #define I2C_COLOR_YELLOW 0
  37 #define I2C_COLOR_BLUE   1
  38
  39 #define I2C_COB_BLACK   0
  40 #define I2C_COB_WHITE   1
  41 #define I2C_COB_UNKNOWN 2
  42 #define I2C_COB_REMOVED 3
  43 #define I2C_COB_NONE    4
  44
  45 struct i2c_cmd_hdr {
  46         uint8_t cmd;
  47 };
  48
  49 /****/
  50 /* commands that do not need and answer */
  51 /****/
  52
  53 #define I2C_CMD_GENERIC_LED_CONTROL 0x00
  54
  55 struct i2c_cmd_led_control {
  56         struct i2c_cmd_hdr hdr;
  57         uint8_t led_num:7;
  58         uint8_t state:1;
  59 };
  60
  61 /****/
  62
  63 #define I2C_CMD_GENERIC_SET_COLOR 0x01
  64
  65 struct i2c_cmd_generic_color {
  66         struct i2c_cmd_hdr hdr;
  67         uint8_t color;
  68 };
  69
  70 /****/
  71
  72 #define I2C_CMD_COBBOARD_SET_MODE 0x02
  73
  74 struct i2c_cmd_cobboard_set_mode {
  75         struct i2c_cmd_hdr hdr;
  76
  77 #define I2C_COBBOARD_MODE_HARVEST      0x01 /* harvest mode */
  78 #define I2C_COBBOARD_MODE_EJECT        0x02 /* eject cobs */
  79 #define I2C_COBBOARD_MODE_INIT         0x03 /* init state machine */
  80         uint8_t mode;
  81 };
  82
  83 #define I2C_CMD_BALLBOARD_SET_MODE 0x10
  84
  85 struct i2c_cmd_ballboard_set_mode {
  86         struct i2c_cmd_hdr hdr;
  87
  88 #define I2C_BALLBOARD_MODE_INIT        0x00
  89 #define I2C_BALLBOARD_MODE_OFF         0x01
  90 #define I2C_BALLBOARD_MODE_HARVEST     0x02
  91 #define I2C_BALLBOARD_MODE_EJECT       0x03
  92 #define I2C_BALLBOARD_MODE_PREP_L_FORK 0x04
  93 #define I2C_BALLBOARD_MODE_TAKE_L_FORK 0x05
  94 #define I2C_BALLBOARD_MODE_PREP_R_FORK 0x06
  95 #define I2C_BALLBOARD_MODE_TAKE_R_FORK 0x07
  96         uint8_t mode;
  97 };
  98
  99 /****/
 100 /* requests and their answers */
 101 /****/
 102
 103
 104 #define I2C_REQ_COBBOARD_STATUS 0x80
 105
 106 struct i2c_req_cobboard_status {
 107         struct i2c_cmd_hdr hdr;
 108
 109 #define I2C_COBBOARD_SPK_DEPLOY  0x01 /* deploy the spickle */
 110 #define I2C_COBBOARD_SPK_AUTOHARVEST 0x02 /* auto harvest the cobs */
 111 #define I2C_COBBOARD_SPK_NO_MOVE 0x04 /* if enabled, don't change state */
 112         uint8_t lspickle;
 113         uint8_t rspickle;
 114 };
 115
 116 #define I2C_ANS_COBBOARD_STATUS 0x81
 117
 118 struct i2c_ans_cobboard_status {
 119         struct i2c_cmd_hdr hdr;
 120
 121         /* mode type are defined above: I2C_COBBOARD_MODE_xxx */
 122         uint8_t mode;
 123
 124 #define I2C_COBBOARD_STATUS_READY         0x00
 125 #define I2C_COBBOARD_STATUS_OFF           0x01
 126 #define I2C_COBBOARD_STATUS_LBUSY         0x02
 127 #define I2C_COBBOARD_STATUS_RBUSY         0x03
 128 #define I2C_COBBOARD_STATUS_EJECT         0x04
 129         uint8_t status;
 130
 131         uint8_t cob_count;
 132
 133         int16_t left_cobroller_speed;
 134         int16_t right_cobroller_speed;
 135 };
 136
 137 #define I2C_REQ_BALLBOARD_STATUS 0x82
 138
 139 struct i2c_req_ballboard_status {
 140         struct i2c_cmd_hdr hdr;
 141 };
 142
 143 #define I2C_ANS_BALLBOARD_STATUS 0x83
 144
 145 struct i2c_ans_ballboard_status {
 146         struct i2c_cmd_hdr hdr;
 147
 148         uint8_t mode;
 149
 150 #define I2C_BALLBOARD_STATUS_F_READY         0x00
 151 #define I2C_BALLBOARD_STATUS_F_BUSY          0x01
 152 #define I2C_BALLBOARD_STATUS_F_EXCPT         0x02
 153         uint8_t status;
 154
 155         uint8_t ball_count;
 156
 157         /* detection of cobs */
 158         uint8_t lcob;
 159         uint8_t rcob;
 160 };
 161
 162 #endif /* _I2C_PROTOCOL_H_ */