i2c.h

Go to the documentation of this file.

/*
 * KubOS HAL
 * Copyright (C) 2016 Kubos Corporation
 *
 * 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.
 */
#if (defined YOTTA_CFG_HARDWARE_I2C) && (YOTTA_CFG_HARDWARE_I2C_COUNT > 0)
#ifndef K_I2C_H
#define K_I2C_H

#include <stdint.h>
#include <csp/arch/csp_semaphore.h>

#ifndef K_NUM_I2CS
#define K_NUM_I2CS YOTTA_CFG_HARDWARE_I2C_COUNT
#endif

#ifndef DEFAULT_I2C
#define DEFAULT_I2C YOTTA_CFG_HARDWARE_I2C_DEFAULTS_BUS
#endif

typedef enum {
    K_I2C_NO_BUS = 0,
#ifdef YOTTA_CFG_HARDWARE_I2C_I2C1
    K_I2C1,
#endif
#ifdef YOTTA_CFG_HARDWARE_I2C_I2C2
    K_I2C2,
#endif
#ifdef YOTTA_CFG_HARDWARE_I2C_I2C3
    K_I2C3
#endif
} KI2CNum;

typedef enum {
    K_ADDRESSINGMODE_7BIT = 0,
    K_ADDRESSINGMODE_10BIT
} I2CAddressingMode;

typedef enum {
    K_MASTER = 0,
    K_SLAVE
} I2CRole;

typedef struct {
    I2CAddressingMode addressing_mode;
    I2CRole role;
    uint32_t clock_speed;
} KI2CConf;

typedef struct {
    KI2CNum bus_num;
    KI2CConf conf;
    csp_mutex_t i2c_lock;
} KI2C;

typedef enum {
    I2C_OK = 0,
    I2C_ERROR,
    I2C_ERROR_AF,
    I2C_ERROR_ADDR_TIMEOUT,
    I2C_ERROR_TIMEOUT,
    I2C_ERROR_NACK,
    I2C_ERROR_TXE_TIMEOUT,
    I2C_ERROR_BTF_TIMEOUT,
    I2C_ERROR_NULL_HANDLE,
    I2C_ERROR_CONFIG
} KI2CStatus;

void k_i2c_init(KI2CNum i2c, KI2CConf *conf);

void k_i2c_terminate(KI2CNum i2c);

KI2CConf k_i2c_conf_defaults(void);

void k_i2c_default_init();

void k_i2c_default_dev_init(KI2CNum i2c);

KI2CStatus k_i2c_write(KI2CNum i2c, uint16_t addr, uint8_t *ptr, int len);

KI2CStatus k_i2c_read(KI2CNum i2c, uint16_t addr, uint8_t *ptr, int len);

KI2C* kprv_i2c_get(KI2CNum i2c);

KI2CStatus kprv_i2c_dev_init(KI2CNum i2c);

KI2CStatus kprv_i2c_dev_terminate(KI2CNum i2c);

KI2CStatus kprv_i2c_master_write(KI2CNum i2c, uint16_t addr, uint8_t *ptr, int len);

KI2CStatus kprv_i2c_master_read(KI2CNum i2c, uint16_t addr, uint8_t *ptr, int len);

KI2CStatus kprv_i2c_slave_write(KI2CNum i2c, uint16_t addr, uint8_t *ptr, int len);

KI2CStatus kprv_i2c_slave_read(KI2CNum i2c, uint16_t addr, uint8_t *ptr, int len);

#endif
#endif
/* @} */