i2c.h

 
/******************************************************************************
 *
 * Copyright (C) 2022-2023 Maxim Integrated Products, Inc. (now owned by 
 * Analog Devices, Inc.),
 * Copyright (C) 2023-2024 Analog Devices, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 ******************************************************************************/
 
/* Define to prevent redundant inclusion */
#ifndef LIBRARIES_PERIPHDRIVERS_INCLUDE_MAX32675_I2C_H_
#define LIBRARIES_PERIPHDRIVERS_INCLUDE_MAX32675_I2C_H_
 
#include <stdint.h>
#include <stdbool.h>
#include "mxc_sys.h"
#include "i2c_regs.h"
#include "dma_regs.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
/***** Definitions *****/
#define MXC_I2C_STD_MODE 100000
#define MXC_I2C_FAST_SPEED 400000
#define MXC_I2C_FASTPLUS_SPEED 1000000
#define MXC_I2C_HIGH_SPEED 3400000
 
typedef struct _i2c_req_t mxc_i2c_req_t;
 
typedef int (*mxc_i2c_getAck_t)(mxc_i2c_regs_t *i2c, unsigned char byte);
 
typedef void (*mxc_i2c_complete_cb_t)(mxc_i2c_req_t *req, int result);
 
typedef void (*mxc_i2c_dma_complete_cb_t)(int len, int result);
 
struct _i2c_req_t {
    mxc_i2c_regs_t *i2c; 
    unsigned int addr; 
    unsigned char *tx_buf; 
    unsigned int tx_len; 
    unsigned char *rx_buf; 
    unsigned int rx_len; 
    int restart; 
    mxc_i2c_complete_cb_t callback; 
};
 
typedef enum {
    MXC_I2C_EVT_MASTER_WR, 
    MXC_I2C_EVT_MASTER_RD, 
    MXC_I2C_EVT_RX_THRESH, 
    MXC_I2C_EVT_TX_THRESH, 
    MXC_I2C_EVT_TRANS_COMP, 
    MXC_I2C_EVT_UNDERFLOW, 
    MXC_I2C_EVT_OVERFLOW, 
} mxc_i2c_slave_event_t;
 
typedef int (*mxc_i2c_slave_handler_t)(mxc_i2c_regs_t *i2c, mxc_i2c_slave_event_t event,
                                       void *data);
 
/***** Function Prototypes *****/
 
/* ************************************************************************* */
/* Control/Configuration functions                                           */
/* ************************************************************************* */
 
int MXC_I2C_Init(mxc_i2c_regs_t *i2c, int masterMode, unsigned int slaveAddr);
 
int MXC_I2C_SetSlaveAddr(mxc_i2c_regs_t *i2c, unsigned int slaveAddr, int idx);
 
int MXC_I2C_Shutdown(mxc_i2c_regs_t *i2c);
 
int MXC_I2C_Reset(mxc_i2c_regs_t *i2c);
 
int MXC_I2C_SetFrequency(mxc_i2c_regs_t *i2c, unsigned int hz);
 
unsigned int MXC_I2C_GetFrequency(mxc_i2c_regs_t *i2c);
 
int MXC_I2C_ReadyForSleep(mxc_i2c_regs_t *i2c);
 
int MXC_I2C_SetClockStretching(mxc_i2c_regs_t *i2c, int enable);
 
int MXC_I2C_GetClockStretching(mxc_i2c_regs_t *i2c);
 
int MXC_I2C_DMA_Init(mxc_i2c_regs_t *i2c, mxc_dma_regs_t *dma, bool use_dma_tx, bool use_dma_rx);
 
int MXC_I2C_DMA_GetTXChannel(mxc_i2c_regs_t *i2c);
 
int MXC_I2C_DMA_GetRXChannel(mxc_i2c_regs_t *i2c);
 
int MXC_I2C_DMA_SetRequestSelect(mxc_i2c_regs_t *i2c, uint8_t *txData, uint8_t *rxData);
 
/* ************************************************************************* */
/* Low-level functions                                                       */
/* ************************************************************************* */
 
int MXC_I2C_Start(mxc_i2c_regs_t *i2c);
 
int MXC_I2C_Stop(mxc_i2c_regs_t *i2c);
 
int MXC_I2C_WriteByte(mxc_i2c_regs_t *i2c, unsigned char byte);
 
int MXC_I2C_ReadByte(mxc_i2c_regs_t *i2c, unsigned char *byte, int ack);
 
int MXC_I2C_ReadByteInteractive(mxc_i2c_regs_t *i2c, unsigned char *byte, mxc_i2c_getAck_t getAck);
 
int MXC_I2C_Write(mxc_i2c_regs_t *i2c, unsigned char *bytes, unsigned int *len);
 
int MXC_I2C_Read(mxc_i2c_regs_t *i2c, unsigned char *bytes, unsigned int *len, int ack);
 
int MXC_I2C_ReadRXFIFO(mxc_i2c_regs_t *i2c, volatile unsigned char *bytes, unsigned int len);
 
int MXC_I2C_ReadRXFIFODMA(mxc_i2c_regs_t *i2c, unsigned char *bytes, unsigned int len,
                          mxc_i2c_dma_complete_cb_t callback);
 
int MXC_I2C_GetRXFIFOAvailable(mxc_i2c_regs_t *i2c);
 
int MXC_I2C_WriteTXFIFO(mxc_i2c_regs_t *i2c, volatile unsigned char *bytes, unsigned int len);
 
int MXC_I2C_WriteTXFIFODMA(mxc_i2c_regs_t *i2c, unsigned char *bytes, unsigned int len,
                           mxc_i2c_dma_complete_cb_t callback);
 
int MXC_I2C_GetTXFIFOAvailable(mxc_i2c_regs_t *i2c);
 
void MXC_I2C_ClearRXFIFO(mxc_i2c_regs_t *i2c);
 
void MXC_I2C_ClearTXFIFO(mxc_i2c_regs_t *i2c);
 
int MXC_I2C_GetFlags(mxc_i2c_regs_t *i2c, unsigned int *flags0, unsigned int *flags1);
 
void MXC_I2C_ClearFlags(mxc_i2c_regs_t *i2c, unsigned int flags0, unsigned int flags1);
 
void MXC_I2C_EnableInt(mxc_i2c_regs_t *i2c, unsigned int flags0, unsigned int flags1);
 
void MXC_I2C_DisableInt(mxc_i2c_regs_t *i2c, unsigned int flags0, unsigned int flags1);
 
void MXC_I2C_EnablePreload(mxc_i2c_regs_t *i2c);
 
void MXC_I2C_DisablePreload(mxc_i2c_regs_t *i2c);
 
void MXC_I2C_EnableGeneralCall(mxc_i2c_regs_t *i2c);
 
void MXC_I2C_DisableGeneralCall(mxc_i2c_regs_t *i2c);
 
void MXC_I2C_SetTimeout(mxc_i2c_regs_t *i2c, unsigned int timeout);
 
unsigned int MXC_I2C_GetTimeout(mxc_i2c_regs_t *i2c);
 
int MXC_I2C_Recover(mxc_i2c_regs_t *i2c, unsigned int retries);
 
/* ************************************************************************* */
/* Transaction level functions                                               */
/* ************************************************************************* */
 
int MXC_I2C_MasterTransaction(mxc_i2c_req_t *req);
 
int MXC_I2C_MasterTransactionAsync(mxc_i2c_req_t *req);
 
int MXC_I2C_MasterTransactionDMA(mxc_i2c_req_t *req);
 
int MXC_I2C_SlaveTransaction(mxc_i2c_regs_t *i2c, mxc_i2c_slave_handler_t callback);
 
int MXC_I2C_SlaveTransactionAsync(mxc_i2c_regs_t *i2c, mxc_i2c_slave_handler_t callback);
 
int MXC_I2C_SetRXThreshold(mxc_i2c_regs_t *i2c, unsigned int numBytes);
 
unsigned int MXC_I2C_GetRXThreshold(mxc_i2c_regs_t *i2c);
 
int MXC_I2C_SetTXThreshold(mxc_i2c_regs_t *i2c, unsigned int numBytes);
 
unsigned int MXC_I2C_GetTXThreshold(mxc_i2c_regs_t *i2c);
 
void MXC_I2C_AsyncStop(mxc_i2c_regs_t *i2c);
 
void MXC_I2C_AbortAsync(mxc_i2c_regs_t *i2c);
 
void MXC_I2C_AsyncHandler(mxc_i2c_regs_t *i2c);
 
void MXC_I2C_DMACallback(int ch, int error);
 
#ifdef __cplusplus
}
#endif
 
#endif // LIBRARIES_PERIPHDRIVERS_INCLUDE_MAX32675_I2C_H_