no-OS
aducm3029_i2c.h
Go to the documentation of this file.
1 /*******************************************************************************
2  * @file aducm3029_i2c.h
3  * @brief Header containing types used in the i2c driver.
4  * @author Andrei Porumb (andrei.porumb@analog.com)
5 ********************************************************************************
6  * Copyright 2021(c) Analog Devices, Inc.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions are met:
10  *
11  * 1. Redistributions of source code must retain the above copyright notice,
12  * this list of conditions and the following disclaimer.
13  *
14  * 2. Redistributions in binary form must reproduce the above copyright notice,
15  * this list of conditions and the following disclaimer in the documentation
16  * and/or other materials provided with the distribution.
17  *
18  * 3. Neither the name of Analog Devices, Inc. nor the names of its
19  * contributors may be used to endorse or promote products derived from this
20  * software without specific prior written permission.
21  *
22  * THIS SOFTWARE IS PROVIDED BY ANALOG DEVICES, INC. “AS IS” AND ANY EXPRESS OR
23  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
24  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
25  * EVENT SHALL ANALOG DEVICES, INC. BE LIABLE FOR ANY DIRECT, INDIRECT,
26  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
27  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
28  * OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
29  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
30  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
31  * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32 *******************************************************************************/
33 
34 #ifndef ADUCM3029_I2C_H_
35 #define ADUCM3029_I2C_H_
36 
37 /******************************************************************************/
38 /*************************** Types Declarations *******************************/
39 /******************************************************************************/
40 
44 extern const struct no_os_i2c_platform_ops aducm_i2c_ops;
45 
46 #endif // ADUCM3029_I2C_H_
aducm_i2c_extra::prologue_size
uint8_t prologue_size
Definition: aducm3029_i2c.c:81
no_os_alloc.h
no_os_i2c_init_param::slave_address
uint8_t slave_address
Definition: no_os_i2c.h:70
UNINITIALIZED_BITRATE
#define UNINITIALIZED_BITRATE
Definition: aducm3029_i2c.c:47
no_os_calloc
void * no_os_calloc(size_t nitems, size_t size)
Allocate memory and return a pointer to it, set memory to 0.
Definition: chibios_alloc.c:54
aducm3029_i2c.h
aducm_i2c_ops
const struct no_os_i2c_platform_ops aducm_i2c_ops
ADuCM3029 specific IRQ platform ops structure.
Definition: aducm3029_i2c.c:314
aducm_i2c_extra::prologue_data
uint8_t * prologue_data
Definition: aducm3029_i2c.c:79
no_os_i2c_desc::slave_address
uint8_t slave_address
Definition: no_os_i2c.h:109
no_os_error.h
Error codes definition.
no_os_i2c_init_param::max_speed_hz
uint32_t max_speed_hz
Definition: no_os_i2c.h:68
aducm_i2c_extra
Definition: aducm3029_i2c.c:77
no_os_i2c_desc::max_speed_hz
uint32_t max_speed_hz
Definition: no_os_i2c.h:107
no_os_i2c_platform_ops
Structure holding I2C function pointers that point to the platform specific function.
Definition: no_os_i2c.h:121
no_os_i2c_platform_ops::i2c_ops_init
int32_t(* i2c_ops_init)(struct no_os_i2c_desc **, const struct no_os_i2c_init_param *)
Definition: no_os_i2c.h:123
UNINITIALIZED_ADDRESS
#define UNINITIALIZED_ADDRESS
Definition: aducm3029_i2c.c:48
no_os_i2c_desc
Structure holding I2C address descriptor.
Definition: no_os_i2c.h:101
no_os_malloc
void * no_os_malloc(size_t size)
Allocate memory and return a pointer to it.
Definition: chibios_alloc.c:43
no_os_i2c.h
Header file of I2C Interface.
no_os_free
void no_os_free(void *ptr)
Deallocate memory previously allocated by a call to no_os_calloc or no_os_malloc.
Definition: chibios_alloc.c:69
no_os_i2c_init_param
Structure holding the parameters for I2C initialization.
Definition: no_os_i2c.h:64
NULL
#define NULL
Definition: wrapper.h:64
aducm_i2c_ops
const struct no_os_i2c_platform_ops aducm_i2c_ops
ADuCM3029 platform specific I2C platform ops structure.
Definition: aducm3029_i2c.c:314
no_os_i2c_desc::extra
void * extra
Definition: no_os_i2c.h:113
Generated by   doxygen 1.8.17