no-OS
All Classes Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
maxim_i2c.h
Go to the documentation of this file.
1/*******************************************************************************
2 * @file maxim_i2c.h
3 * @brief Header containing types used in the i2c driver.
4 * @author Andrei Drimbarean (andrei.drimbarean@analog.com)
5 * @author Ciprian Regus (ciprian.regus@analog.com)
6********************************************************************************
7 * Copyright 2022(c) Analog Devices, Inc.
8 *
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions are met:
11 *
12 * 1. Redistributions of source code must retain the above copyright notice,
13 * this list of conditions and the following disclaimer.
14 *
15 * 2. Redistributions in binary form must reproduce the above copyright notice,
16 * this list of conditions and the following disclaimer in the documentation
17 * and/or other materials provided with the distribution.
18 *
19 * 3. Neither the name of Analog Devices, Inc. nor the names of its
20 * contributors may be used to endorse or promote products derived from this
21 * software without specific prior written permission.
22 *
23 * THIS SOFTWARE IS PROVIDED BY ANALOG DEVICES, INC. “AS IS” AND ANY EXPRESS OR
24 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
25 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
26 * EVENT SHALL ANALOG DEVICES, INC. BE LIABLE FOR ANY DIRECT, INDIRECT,
27 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
28 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
29 * OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
30 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
31 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
32 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33*******************************************************************************/
34
35#ifndef MAXIM_I2C_H_
36#define MAXIM_I2C_H_
37
38#include <stdint.h>
39#include "i2c_regs.h"
40#include "max32655.h"
41#include "gpio.h"
42#include "no_os_i2c.h"
43
48struct max_i2c_extra {
50 mxc_i2c_regs_t *handler;
53 uint8_t *prologue_data;
56 uint8_t prologue_size;
57};
58
59struct max_i2c_init_param {
60 mxc_gpio_vssel_t vssel;
61};
62
73
77extern const struct no_os_i2c_platform_ops max_i2c_ops;
78
79#endif /* MAXIM_I2C_H_ */
const struct no_os_i2c_platform_ops max_i2c_ops
MAXIM platform specific I2C platform ops structure.
Definition maxim_i2c.c:320
max_i2c_speed
MAXIM I2C SCL frequency options.
Definition maxim_i2c.h:66
@ MAX_I2C_STD_MODE
Definition maxim_i2c.h:67
@ MAX_I2C_HS_MODE
Definition maxim_i2c.h:70
@ MAX_I2C_FAST_PLUS_MODE
Definition maxim_i2c.h:69
@ MAX_I2C_FAST_MODE
Definition maxim_i2c.h:68
Header file of I2C Interface.
MAXIM specific I2C handler structure.
Definition maxim_i2c.h:47
mxc_i2c_regs_t * handler
Definition maxim_i2c.h:49
uint8_t * prologue_data
Definition maxim_i2c.h:52
uint8_t prologue_size
Definition maxim_i2c.h:55
Definition maxim_i2c.h:58
mxc_gpio_vssel_t vssel
Definition maxim_i2c.h:59
Structure holding I2C function pointers that point to the platform specific function.
Definition no_os_i2c.h:109