ferris/0_1: update I2C API usage (#24839)
				
					
				
			This commit is contained in:
		
							parent
							
								
									a98070f212
								
							
						
					
					
						commit
						68130cc8a5
					
				
					 3 changed files with 21 additions and 30 deletions
				
			
		| 
						 | 
					@ -29,7 +29,7 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 | 
				
			||||||
#include "i2c_master.h"
 | 
					#include "i2c_master.h"
 | 
				
			||||||
 | 
					
 | 
				
			||||||
extern i2c_status_t mcp23017_status;
 | 
					extern i2c_status_t mcp23017_status;
 | 
				
			||||||
#define I2C_TIMEOUT 1000
 | 
					#define MCP23017_I2C_TIMEOUT 1000
 | 
				
			||||||
 | 
					
 | 
				
			||||||
// For a better understanding of the i2c protocol, this is a good read:
 | 
					// For a better understanding of the i2c protocol, this is a good read:
 | 
				
			||||||
// https://www.robot-electronics.co.uk/i2c-tutorial
 | 
					// https://www.robot-electronics.co.uk/i2c-tutorial
 | 
				
			||||||
| 
						 | 
					@ -41,9 +41,7 @@ extern i2c_status_t mcp23017_status;
 | 
				
			||||||
// All address pins of the mcp23017 are connected to the ground on the ferris
 | 
					// All address pins of the mcp23017 are connected to the ground on the ferris
 | 
				
			||||||
// | 0  | 1  | 0  | 0  | A2 | A1 | A0 |
 | 
					// | 0  | 1  | 0  | 0  | A2 | A1 | A0 |
 | 
				
			||||||
// | 0  | 1  | 0  | 0  | 0  | 0  | 0  |
 | 
					// | 0  | 1  | 0  | 0  | 0  | 0  | 0  |
 | 
				
			||||||
#define I2C_ADDR 0b0100000
 | 
					#define I2C_ADDR (0b0100000 << 1)
 | 
				
			||||||
#define I2C_ADDR_WRITE ((I2C_ADDR << 1) | I2C_WRITE)
 | 
					 | 
				
			||||||
#define I2C_ADDR_READ ((I2C_ADDR << 1) | I2C_READ)
 | 
					 | 
				
			||||||
 | 
					
 | 
				
			||||||
// Register addresses
 | 
					// Register addresses
 | 
				
			||||||
// See https://github.com/adafruit/Adafruit-MCP23017-Arduino-Library/blob/master/Adafruit_MCP23017.h
 | 
					// See https://github.com/adafruit/Adafruit-MCP23017-Arduino-Library/blob/master/Adafruit_MCP23017.h
 | 
				
			||||||
| 
						 | 
					@ -51,8 +49,8 @@ extern i2c_status_t mcp23017_status;
 | 
				
			||||||
#define IODIRB 0x01
 | 
					#define IODIRB 0x01
 | 
				
			||||||
#define GPPUA 0x0C  // GPIO pull-up resistor register
 | 
					#define GPPUA 0x0C  // GPIO pull-up resistor register
 | 
				
			||||||
#define GPPUB 0x0D
 | 
					#define GPPUB 0x0D
 | 
				
			||||||
#define GPIOA 0x12  // general purpose i/o port register (write modifies OLAT)
 | 
					#define MCP23017_GPIOA 0x12  // general purpose i/o port register (write modifies OLAT)
 | 
				
			||||||
#define GPIOB 0x13
 | 
					#define MCP23017_GPIOB 0x13
 | 
				
			||||||
#define OLATA 0x14  // output latch register
 | 
					#define OLATA 0x14  // output latch register
 | 
				
			||||||
#define OLATB 0x15
 | 
					#define OLATB 0x15
 | 
				
			||||||
 | 
					
 | 
				
			||||||
| 
						 | 
					@ -60,14 +58,14 @@ bool         i2c_initialized = 0;
 | 
				
			||||||
i2c_status_t mcp23017_status = I2C_ADDR;
 | 
					i2c_status_t mcp23017_status = I2C_ADDR;
 | 
				
			||||||
 | 
					
 | 
				
			||||||
uint8_t init_mcp23017(void) {
 | 
					uint8_t init_mcp23017(void) {
 | 
				
			||||||
    print("starting init");
 | 
					    print("init mcp23017\n");
 | 
				
			||||||
    mcp23017_status = I2C_ADDR;
 | 
					    mcp23017_status = I2C_ADDR;
 | 
				
			||||||
 | 
					
 | 
				
			||||||
    // I2C subsystem
 | 
					    // I2C subsystem
 | 
				
			||||||
    if (i2c_initialized == 0) {
 | 
					    if (i2c_initialized == 0) {
 | 
				
			||||||
        i2c_init();  // on pins D(1,0)
 | 
					        i2c_init();  // on pins D(1,0)
 | 
				
			||||||
        i2c_initialized = true;
 | 
					        i2c_initialized = true;
 | 
				
			||||||
        wait_ms(I2C_TIMEOUT);
 | 
					        wait_ms(MCP23017_I2C_TIMEOUT);
 | 
				
			||||||
    }
 | 
					    }
 | 
				
			||||||
 | 
					
 | 
				
			||||||
    // set pin direction
 | 
					    // set pin direction
 | 
				
			||||||
| 
						 | 
					@ -76,8 +74,10 @@ uint8_t init_mcp23017(void) {
 | 
				
			||||||
    // - driving : output : 0
 | 
					    // - driving : output : 0
 | 
				
			||||||
    // This means: we will read all the bits on GPIOA
 | 
					    // This means: we will read all the bits on GPIOA
 | 
				
			||||||
    // This means: we will write to the pins 0-4 on GPIOB (in select_rows)
 | 
					    // This means: we will write to the pins 0-4 on GPIOB (in select_rows)
 | 
				
			||||||
    uint8_t buf[]   = {IODIRA, 0b11111111, 0b11110000};
 | 
					    uint8_t buf[] = {0b11111111, 0b11110000};
 | 
				
			||||||
    mcp23017_status = i2c_transmit(I2C_ADDR_WRITE, buf, sizeof(buf), I2C_TIMEOUT);
 | 
					    print("before transmit\n");
 | 
				
			||||||
 | 
					    mcp23017_status = i2c_write_register(I2C_ADDR, IODIRA, buf, sizeof(buf), MCP23017_I2C_TIMEOUT);
 | 
				
			||||||
 | 
					    uprintf("after transmit %i\n", mcp23017_status);
 | 
				
			||||||
    if (!mcp23017_status) {
 | 
					    if (!mcp23017_status) {
 | 
				
			||||||
        // set pull-up
 | 
					        // set pull-up
 | 
				
			||||||
        // - unused  : on  : 1
 | 
					        // - unused  : on  : 1
 | 
				
			||||||
| 
						 | 
					@ -85,8 +85,8 @@ uint8_t init_mcp23017(void) {
 | 
				
			||||||
        // - driving : off : 0
 | 
					        // - driving : off : 0
 | 
				
			||||||
        // This means: we will read all the bits on GPIOA
 | 
					        // This means: we will read all the bits on GPIOA
 | 
				
			||||||
        // This means: we will write to the pins 0-4 on GPIOB (in select_rows)
 | 
					        // This means: we will write to the pins 0-4 on GPIOB (in select_rows)
 | 
				
			||||||
        uint8_t pullup_buf[] = {GPPUA, 0b11111111, 0b11110000};
 | 
					        mcp23017_status = i2c_write_register(I2C_ADDR, GPPUA, buf, sizeof(buf), MCP23017_I2C_TIMEOUT);
 | 
				
			||||||
        mcp23017_status      = i2c_transmit(I2C_ADDR_WRITE, pullup_buf, sizeof(pullup_buf), I2C_TIMEOUT);
 | 
					        uprintf("after transmit2 %i\n", mcp23017_status);
 | 
				
			||||||
    }
 | 
					    }
 | 
				
			||||||
    return mcp23017_status;
 | 
					    return mcp23017_status;
 | 
				
			||||||
}
 | 
					}
 | 
				
			||||||
| 
						 | 
					@ -144,12 +144,12 @@ bool matrix_scan_custom(matrix_row_t current_matrix[]) {
 | 
				
			||||||
            // if (++mcp23017_reset_loop >= 1300) {
 | 
					            // if (++mcp23017_reset_loop >= 1300) {
 | 
				
			||||||
            // since mcp23017_reset_loop is 8 bit - we'll try to reset once in 255 matrix scans
 | 
					            // since mcp23017_reset_loop is 8 bit - we'll try to reset once in 255 matrix scans
 | 
				
			||||||
            // this will be approx bit more frequent than once per second
 | 
					            // this will be approx bit more frequent than once per second
 | 
				
			||||||
            dprint("trying to reset mcp23017\n");
 | 
					            print("trying to reset mcp23017\n");
 | 
				
			||||||
            mcp23017_status = init_mcp23017();
 | 
					            mcp23017_status = init_mcp23017();
 | 
				
			||||||
            if (mcp23017_status) {
 | 
					            if (mcp23017_status) {
 | 
				
			||||||
                dprint("right side not responding\n");
 | 
					                print("right side not responding\n");
 | 
				
			||||||
            } else {
 | 
					            } else {
 | 
				
			||||||
                dprint("right side attached\n");
 | 
					                print("right side attached\n");
 | 
				
			||||||
            }
 | 
					            }
 | 
				
			||||||
        }
 | 
					        }
 | 
				
			||||||
    }
 | 
					    }
 | 
				
			||||||
| 
						 | 
					@ -204,18 +204,13 @@ static matrix_row_t read_cols(uint8_t row) {
 | 
				
			||||||
        if (mcp23017_status) {  // if there was an error
 | 
					        if (mcp23017_status) {  // if there was an error
 | 
				
			||||||
            return 0;
 | 
					            return 0;
 | 
				
			||||||
        } else {
 | 
					        } else {
 | 
				
			||||||
            uint8_t buf[]   = {GPIOA};
 | 
					 | 
				
			||||||
            mcp23017_status = i2c_transmit(I2C_ADDR_WRITE, buf, sizeof(buf), I2C_TIMEOUT);
 | 
					 | 
				
			||||||
            // We read all the pins on GPIOA.
 | 
					            // We read all the pins on GPIOA.
 | 
				
			||||||
            // The initial state was all ones and any depressed key at a given column for the currently selected row will have its bit flipped to zero.
 | 
					            // The initial state was all ones and any depressed key at a given column for the currently selected row will have its bit flipped to zero.
 | 
				
			||||||
            // The return value is a row as represented in the generic matrix code were the rightmost bits represent the lower columns and zeroes represent non-depressed keys while ones represent depressed keys.
 | 
					            // The return value is a row as represented in the generic matrix code were the rightmost bits represent the lower columns and zeroes represent non-depressed keys while ones represent depressed keys.
 | 
				
			||||||
            // Since the pins connected to eact columns are sequential, and counting from zero up (col 5 -> GPIOA0, col 6 -> GPIOA1 and so on), the only transformation needed is a bitwise not to swap all zeroes and ones.
 | 
					            // Since the pins connected to eact columns are sequential, and counting from zero up (col 5 -> GPIOA0, col 6 -> GPIOA1 and so on), the only transformation needed is a bitwise not to swap all zeroes and ones.
 | 
				
			||||||
            uint8_t data[] = {0};
 | 
					            uint8_t data[] = {0};
 | 
				
			||||||
            if (!mcp23017_status) {
 | 
					            mcp23017_status = i2c_read_register(I2C_ADDR, MCP23017_GPIOA, data, sizeof(data), MCP23017_I2C_TIMEOUT);
 | 
				
			||||||
                mcp23017_status = i2c_receive(I2C_ADDR_READ, data, sizeof(data), I2C_TIMEOUT);
 | 
					            return ~data[0];
 | 
				
			||||||
                data[0]         = ~(data[0]);
 | 
					 | 
				
			||||||
            }
 | 
					 | 
				
			||||||
            return data[0];
 | 
					 | 
				
			||||||
        }
 | 
					        }
 | 
				
			||||||
    }
 | 
					    }
 | 
				
			||||||
}
 | 
					}
 | 
				
			||||||
| 
						 | 
					@ -236,7 +231,7 @@ static void unselect_rows(void) {
 | 
				
			||||||
 | 
					
 | 
				
			||||||
static void select_row(uint8_t row) {
 | 
					static void select_row(uint8_t row) {
 | 
				
			||||||
    if (row < MATRIX_ROWS_PER_SIDE) {
 | 
					    if (row < MATRIX_ROWS_PER_SIDE) {
 | 
				
			||||||
        // select on atmega32u4
 | 
					        // select on MCU
 | 
				
			||||||
        pin_t matrix_row_pins_mcu[MATRIX_ROWS_PER_SIDE] = MATRIX_ROW_PINS_MCU;
 | 
					        pin_t matrix_row_pins_mcu[MATRIX_ROWS_PER_SIDE] = MATRIX_ROW_PINS_MCU;
 | 
				
			||||||
        pin_t pin                                       = matrix_row_pins_mcu[row];
 | 
					        pin_t pin                                       = matrix_row_pins_mcu[row];
 | 
				
			||||||
        gpio_set_pin_output(pin);
 | 
					        gpio_set_pin_output(pin);
 | 
				
			||||||
| 
						 | 
					@ -248,8 +243,8 @@ static void select_row(uint8_t row) {
 | 
				
			||||||
        } else {
 | 
					        } else {
 | 
				
			||||||
            // Select the desired row by writing a byte for the entire GPIOB bus where only the bit representing the row we want to select is a zero (write instruction) and every other bit is a one.
 | 
					            // Select the desired row by writing a byte for the entire GPIOB bus where only the bit representing the row we want to select is a zero (write instruction) and every other bit is a one.
 | 
				
			||||||
            // Note that the row - MATRIX_ROWS_PER_SIDE reflects the fact that being on the right hand, the columns are numbered from MATRIX_ROWS_PER_SIDE to MATRIX_ROWS, but the pins we want to write to are indexed from zero up on the GPIOB bus.
 | 
					            // Note that the row - MATRIX_ROWS_PER_SIDE reflects the fact that being on the right hand, the columns are numbered from MATRIX_ROWS_PER_SIDE to MATRIX_ROWS, but the pins we want to write to are indexed from zero up on the GPIOB bus.
 | 
				
			||||||
            uint8_t buf[]   = {GPIOB, 0xFF & ~(1 << (row - MATRIX_ROWS_PER_SIDE))};
 | 
					            uint8_t buf[]   = {0xFF & ~(1 << (row - MATRIX_ROWS_PER_SIDE))};
 | 
				
			||||||
            mcp23017_status = i2c_transmit(I2C_ADDR_WRITE, buf, sizeof(buf), I2C_TIMEOUT);
 | 
					            mcp23017_status = i2c_write_register(I2C_ADDR, MCP23017_GPIOB, buf, sizeof(buf), MCP23017_I2C_TIMEOUT);
 | 
				
			||||||
        }
 | 
					        }
 | 
				
			||||||
    }
 | 
					    }
 | 
				
			||||||
}
 | 
					}
 | 
				
			||||||
| 
						 | 
					
 | 
				
			||||||
| 
						 | 
					@ -30,8 +30,7 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
extern i2c_status_t mcp23017_status;
 | 
					extern i2c_status_t mcp23017_status;
 | 
				
			||||||
#define MCP23017_I2C_TIMEOUT 1000
 | 
					#define MCP23017_I2C_TIMEOUT 1000
 | 
				
			||||||
#define I2C_WRITE 0x00
 | 
					
 | 
				
			||||||
#define I2C_READ 0x01
 | 
					 | 
				
			||||||
// For a better understanding of the i2c protocol, this is a good read:
 | 
					// For a better understanding of the i2c protocol, this is a good read:
 | 
				
			||||||
// https://www.robot-electronics.co.uk/i2c-tutorial
 | 
					// https://www.robot-electronics.co.uk/i2c-tutorial
 | 
				
			||||||
 | 
					
 | 
				
			||||||
| 
						 | 
					
 | 
				
			||||||
| 
						 | 
					@ -21,9 +21,6 @@
 | 
				
			||||||
 | 
					
 | 
				
			||||||
#include <stdint.h>
 | 
					#include <stdint.h>
 | 
				
			||||||
 | 
					
 | 
				
			||||||
#define I2C_READ 0x01
 | 
					 | 
				
			||||||
#define I2C_WRITE 0x00
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
typedef int16_t i2c_status_t;
 | 
					typedef int16_t i2c_status_t;
 | 
				
			||||||
 | 
					
 | 
				
			||||||
#define I2C_STATUS_SUCCESS (0)
 | 
					#define I2C_STATUS_SUCCESS (0)
 | 
				
			||||||
| 
						 | 
					
 | 
				
			||||||
		Loading…
	
	Add table
		Add a link
		
	
		Reference in a new issue