pico_i2c.h File Reference

Header file for the pico i2c driver. More...

#include "no_os_i2c.h"
#include "hardware/i2c.h"

Include dependency graph for pico_i2c.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	pico_i2c_desc
	pico platform specific I2C descriptor More...
struct	pico_i2c_init_param
	Additional I2C config parameters. More...

Enumerations
enum	i2c_sda_gp {   I2C0_SDA_GP0 = 0,   I2C0_SDA_GP4 = 4,   I2C0_SDA_GP8 = 8,   I2C0_SDA_GP12 = 12,   I2C0_SDA_GP16 = 16,   I2C0_SDA_GP20 = 20,   I2C1_SDA_GP2 = 2,   I2C1_SDA_GP6 = 6,   I2C1_SDA_GP10 = 10,   I2C1_SDA_GP14 = 14,   I2C1_SDA_GP18 = 18,   I2C1_SDA_GP26 = 26 }
	Available GP config for I2c SDA. More...
enum	i2c_scl_gp {   I2C0_SCL_GP1 = 1,   I2C0_SCL_GP5 = 5,   I2C0_SCL_GP9 = 9,   I2C0_SCL_GP13 = 13,   I2C0_SCL_GP17 = 17,   I2C0_SCL_GP21 = 21,   I2C1_SCL_GP3 = 3,   I2C1_SCL_GP7 = 7,   I2C1_SCL_GP11 = 11,   I2C1_SCL_GP15 = 15,   I2C1_SCL_GP19 = 19,   I2C1_SCL_GP27 = 27 }
	Available GP config for I2C SCL. More...

Variables
const struct no_os_i2c_platform_ops	pico_i2c_ops
	pico specific I2C platform ops structure More...

Detailed Description

Header file for the pico i2c driver.

Author

RBolboac (ramon.nosp@m.a.bo.nosp@m.lboac.nosp@m.a@an.nosp@m.alog..nosp@m.com)

Copyright 2022(c) Analog Devices, Inc.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
3. Neither the name of Analog Devices, Inc. nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY ANALOG DEVICES, INC. “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL ANALOG DEVICES, INC. BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Enumeration Type Documentation

i2c_scl_gp

enum i2c_scl_gp

Available GP config for I2C SCL.

Enumerator
I2C0_SCL_GP1
I2C0_SCL_GP5
I2C0_SCL_GP9
I2C0_SCL_GP13
I2C0_SCL_GP17
I2C0_SCL_GP21
I2C1_SCL_GP3
I2C1_SCL_GP7
I2C1_SCL_GP11
I2C1_SCL_GP15
I2C1_SCL_GP19
I2C1_SCL_GP27

i2c_sda_gp

enum i2c_sda_gp

Available GP config for I2c SDA.

Enumerator
I2C0_SDA_GP0
I2C0_SDA_GP4
I2C0_SDA_GP8
I2C0_SDA_GP12
I2C0_SDA_GP16
I2C0_SDA_GP20
I2C1_SDA_GP2
I2C1_SDA_GP6
I2C1_SDA_GP10
I2C1_SDA_GP14
I2C1_SDA_GP18
I2C1_SDA_GP26

Variable Documentation

pico_i2c_ops

const struct no_os_i2c_platform_ops pico_i2c_ops

pico specific I2C platform ops structure

pico specific I2C platform ops structure