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  * All rights reserved.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions are met:
12  * - Redistributions of source code must retain the above copyright
13  * notice, this list of conditions and the following disclaimer.
14  * - Redistributions in binary form must reproduce the above copyright
15  * notice, this list of conditions and the following disclaimer in
16  * the documentation and/or other materials provided with the
17  * distribution.
18  * - Neither the name of Analog Devices, Inc. nor the names of its
19  * contributors may be used to endorse or promote products derived
20  * from this software without specific prior written permission.
21  * - The use of this software may or may not infringe the patent rights
22  * of one or more patent holders. This license does not release you
23  * from the requirement that you obtain separate licenses from these
24  * patent holders to use this software.
25  * - Use of the software either in source or binary form, must be run
26  * on or directly connected to an Analog Devices Inc. component.
27  *
28  * THIS SOFTWARE IS PROVIDED BY ANALOG DEVICES "AS IS" AND ANY EXPRESS OR
29  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, NON-INFRINGEMENT,
30  * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
31  * IN NO EVENT SHALL ANALOG DEVICES BE LIABLE FOR ANY DIRECT, INDIRECT,
32  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
33  * LIMITED TO, INTELLECTUAL PROPERTY RIGHTS, PROCUREMENT OF SUBSTITUTE GOODS OR
34  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
35  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
36  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
37  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
38 *******************************************************************************/
39 
40 #ifndef ADUCM3029_I2C_H_
41 #define ADUCM3029_I2C_H_
42 
43 /******************************************************************************/
44 /*************************** Types Declarations *******************************/
45 /******************************************************************************/
46 
50 extern const struct no_os_i2c_platform_ops aducm_i2c_ops;
51 
52 #endif // ADUCM3029_I2C_H_
aducm_i2c_extra::prologue_size
uint8_t prologue_size
Definition: aducm3029_i2c.c:87
no_os_alloc.h
no_os_i2c_init_param::slave_address
uint8_t slave_address
Definition: no_os_i2c.h:76
UNINITIALIZED_BITRATE
#define UNINITIALIZED_BITRATE
Definition: aducm3029_i2c.c:53
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:60
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:320
aducm_i2c_extra::prologue_data
uint8_t * prologue_data
Definition: aducm3029_i2c.c:85
no_os_i2c_desc::slave_address
uint8_t slave_address
Definition: no_os_i2c.h:115
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:74
aducm_i2c_extra
Definition: aducm3029_i2c.c:83
no_os_i2c_desc::max_speed_hz
uint32_t max_speed_hz
Definition: no_os_i2c.h:113
no_os_i2c_platform_ops
Structure holding I2C function pointers that point to the platform specific function.
Definition: no_os_i2c.h:127
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:129
UNINITIALIZED_ADDRESS
#define UNINITIALIZED_ADDRESS
Definition: aducm3029_i2c.c:54
no_os_i2c_desc
Structure holding I2C address descriptor.
Definition: no_os_i2c.h:107
no_os_malloc
void * no_os_malloc(size_t size)
Allocate memory and return a pointer to it.
Definition: chibios_alloc.c:49
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:75
no_os_i2c_init_param
Structure holding the parameters for I2C initialization.
Definition: no_os_i2c.h:70
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:320
no_os_i2c_desc::extra
void * extra
Definition: no_os_i2c.h:119