vsf_i2c_util.h

Go to the documentation of this file.

/*****************************************************************************
 *   Copyright(C)2009-2022 by VSF Team                                       *
 *                                                                           *
 *  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.                                           *
 *                                                                           *
 ****************************************************************************/
 
#ifndef __HAL_I2C_UTIL_H__
#define __HAL_I2C_UTIL_H__
 
/* Utilities for i2c: reg access utility, etc */
 
/*============================ INCLUDES ======================================*/
 
#if VSF_HAL_USE_I2C == ENABLED
 
#if     defined(__VSF_I2C_UTIL_CLASS_IMPLEMENT)
#   undef __VSF_I2C_UTIL_CLASS_IMPLEMENT
#   define __VSF_CLASS_IMPLEMENT__
#elif   defined(__VSF_I2C_UTIL_CLASS_INHERIT__)
#   undef __VSF_I2C_UTIL_CLASS_INHERIT__
#   define __VSF_CLASS_INHERIT__
#endif
 
#include "utilities/ooc_class.h"
 
/*============================ MACROS ========================================*/
/*============================ MACROFIED FUNCTIONS ===========================*/
/*============================ INCLUDES ======================================*/
/*============================ TYPES =========================================*/
 
vsf_class(vsf_i2c_regacc_t) {
    public_member(
        vsf_i2c_t *i2c_ptr;
        uint8_t i2c_addr;
        // register address size in bytes: 1 or 2(sent big-endian, for
        // devices with a 16-bit register map). device drivers state this
        // explicitly in their init; the instance zero default reads as 1
        // only to keep pre-existing callers source-compatible
        uint8_t reg_addr_len;
    )
    protected_member(
        uint16_t reg;
        uint16_t datalen;
        void *data;
    )
    private_member(
        // register address staging bytes(big-endian), implementation
        // scratch only - no consumer touches it across completion
        uint8_t reg_buf[2];
        uint8_t is_busy     : 1;
        uint8_t is_read     : 1;
        uint8_t is_regaddr  : 1;
    )
};
 
/*============================ GLOBAL VARIABLES ==============================*/
/*============================ LOCAL VARIABLES ===============================*/
/*============================ PROTOTYPES ====================================*/
/*============================ IMPLEMENTATION ================================*/
 
extern vsf_err_t vsf_i2c_regacc_irqhandler(vsf_i2c_regacc_t *i2c_regacc,
                        vsf_i2c_irq_mask_t irq_mask);
extern vsf_err_t vsf_i2c_regacc(vsf_i2c_regacc_t *i2c_regacc, uint_fast16_t reg,
                        bool is_read, uint8_t *data, uint_fast16_t datalen);
 
#endif      // VSF_HAL_USE_I2C
#endif      // __HAL_I2C_UTIL_H__