Unify i2c_master headers (#24846)
* Unify i2c_master headers * More documentation improvements * Reorganise PAL mode defaults
This commit is contained in:
		
							parent
							
								
									291d154d7b
								
							
						
					
					
						commit
						ef29a46c87
					
				
					 5 changed files with 225 additions and 136 deletions
				
			
		| 
						 | 
				
			
			@ -29,17 +29,37 @@
 | 
			
		|||
#include "i2c_master.h"
 | 
			
		||||
#include "gpio.h"
 | 
			
		||||
#include "chibios_config.h"
 | 
			
		||||
#include <string.h>
 | 
			
		||||
#include <ch.h>
 | 
			
		||||
#include <hal.h>
 | 
			
		||||
 | 
			
		||||
#ifndef I2C_DRIVER
 | 
			
		||||
#    define I2C_DRIVER I2CD1
 | 
			
		||||
#endif
 | 
			
		||||
 | 
			
		||||
#ifndef I2C1_SCL_PIN
 | 
			
		||||
#    define I2C1_SCL_PIN B6
 | 
			
		||||
#endif
 | 
			
		||||
 | 
			
		||||
#ifndef I2C1_SCL_PAL_MODE
 | 
			
		||||
#    ifdef USE_GPIOV1
 | 
			
		||||
#        define I2C1_SCL_PAL_MODE PAL_MODE_ALTERNATE_OPENDRAIN
 | 
			
		||||
#    else
 | 
			
		||||
#        define I2C1_SCL_PAL_MODE 4
 | 
			
		||||
#    endif
 | 
			
		||||
#endif
 | 
			
		||||
 | 
			
		||||
#ifndef I2C1_SDA_PIN
 | 
			
		||||
#    define I2C1_SDA_PIN B7
 | 
			
		||||
#endif
 | 
			
		||||
 | 
			
		||||
#ifndef I2C1_SDA_PAL_MODE
 | 
			
		||||
#    ifdef USE_GPIOV1
 | 
			
		||||
#        define I2C1_SDA_PAL_MODE PAL_MODE_ALTERNATE_OPENDRAIN
 | 
			
		||||
#    else
 | 
			
		||||
#        define I2C1_SDA_PAL_MODE 4
 | 
			
		||||
#    endif
 | 
			
		||||
#endif
 | 
			
		||||
 | 
			
		||||
#ifdef USE_I2CV1
 | 
			
		||||
#    ifndef I2C1_OPMODE
 | 
			
		||||
#        define I2C1_OPMODE OPMODE_I2C
 | 
			
		||||
| 
						 | 
				
			
			@ -70,27 +90,6 @@
 | 
			
		|||
#    endif
 | 
			
		||||
#endif
 | 
			
		||||
 | 
			
		||||
#ifndef I2C_DRIVER
 | 
			
		||||
#    define I2C_DRIVER I2CD1
 | 
			
		||||
#endif
 | 
			
		||||
 | 
			
		||||
#ifdef USE_GPIOV1
 | 
			
		||||
#    ifndef I2C1_SCL_PAL_MODE
 | 
			
		||||
#        define I2C1_SCL_PAL_MODE PAL_MODE_ALTERNATE_OPENDRAIN
 | 
			
		||||
#    endif
 | 
			
		||||
#    ifndef I2C1_SDA_PAL_MODE
 | 
			
		||||
#        define I2C1_SDA_PAL_MODE PAL_MODE_ALTERNATE_OPENDRAIN
 | 
			
		||||
#    endif
 | 
			
		||||
#else
 | 
			
		||||
// The default PAL alternate modes are used to signal that the pins are used for I2C
 | 
			
		||||
#    ifndef I2C1_SCL_PAL_MODE
 | 
			
		||||
#        define I2C1_SCL_PAL_MODE 4
 | 
			
		||||
#    endif
 | 
			
		||||
#    ifndef I2C1_SDA_PAL_MODE
 | 
			
		||||
#        define I2C1_SDA_PAL_MODE 4
 | 
			
		||||
#    endif
 | 
			
		||||
#endif
 | 
			
		||||
 | 
			
		||||
static const I2CConfig i2cconfig = {
 | 
			
		||||
#if defined(USE_I2CV1_CONTRIB)
 | 
			
		||||
    I2C1_CLOCK_SPEED,
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
| 
						 | 
				
			
			@ -1,42 +0,0 @@
 | 
			
		|||
/* Copyright 2018 Jack Humbert
 | 
			
		||||
 * Copyright 2018 Yiancar
 | 
			
		||||
 *
 | 
			
		||||
 * This program is free software: you can redistribute it and/or modify
 | 
			
		||||
 * it under the terms of the GNU General Public License as published by
 | 
			
		||||
 * the Free Software Foundation, either version 2 of the License, or
 | 
			
		||||
 * (at your option) any later version.
 | 
			
		||||
 *
 | 
			
		||||
 * This program is distributed in the hope that it will be useful,
 | 
			
		||||
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 | 
			
		||||
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 | 
			
		||||
 * GNU General Public License for more details.
 | 
			
		||||
 *
 | 
			
		||||
 * You should have received a copy of the GNU General Public License
 | 
			
		||||
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 | 
			
		||||
 */
 | 
			
		||||
 | 
			
		||||
/* This library follows the convention of the AVR i2c_master library.
 | 
			
		||||
 * As a result addresses are expected to be already shifted (addr << 1).
 | 
			
		||||
 * I2CD1 is the default driver which corresponds to pins B6 and B7. This
 | 
			
		||||
 * can be changed.
 | 
			
		||||
 * Please ensure that HAL_USE_I2C is TRUE in the halconf.h file and that
 | 
			
		||||
 * STM32_I2C_USE_I2C1 is TRUE in the mcuconf.h file.
 | 
			
		||||
 */
 | 
			
		||||
#pragma once
 | 
			
		||||
 | 
			
		||||
#include <stdint.h>
 | 
			
		||||
 | 
			
		||||
typedef int16_t i2c_status_t;
 | 
			
		||||
 | 
			
		||||
#define I2C_STATUS_SUCCESS (0)
 | 
			
		||||
#define I2C_STATUS_ERROR (-1)
 | 
			
		||||
#define I2C_STATUS_TIMEOUT (-2)
 | 
			
		||||
 | 
			
		||||
void         i2c_init(void);
 | 
			
		||||
i2c_status_t i2c_transmit(uint8_t address, const uint8_t* data, uint16_t length, uint16_t timeout);
 | 
			
		||||
i2c_status_t i2c_receive(uint8_t address, uint8_t* data, uint16_t length, uint16_t timeout);
 | 
			
		||||
i2c_status_t i2c_write_register(uint8_t devaddr, uint8_t regaddr, const uint8_t* data, uint16_t length, uint16_t timeout);
 | 
			
		||||
i2c_status_t i2c_write_register16(uint8_t devaddr, uint16_t regaddr, const uint8_t* data, uint16_t length, uint16_t timeout);
 | 
			
		||||
i2c_status_t i2c_read_register(uint8_t devaddr, uint8_t regaddr, uint8_t* data, uint16_t length, uint16_t timeout);
 | 
			
		||||
i2c_status_t i2c_read_register16(uint8_t devaddr, uint16_t regaddr, uint8_t* data, uint16_t length, uint16_t timeout);
 | 
			
		||||
i2c_status_t i2c_ping_address(uint8_t address, uint16_t timeout);
 | 
			
		||||
		Loading…
	
	Add table
		Add a link
		
	
		Reference in a new issue