gmsl_reg_access.h

Go to the documentation of this file.

/*******************************************************************************
 *   @file   gmsl_reg_access.h
 *   @brief  Header file of GMSL Register Access.
 *   @author Automotive Software and Systems team, Bangalore, India
********************************************************************************
 * Copyright 2025(c) Analog Devices, Inc.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 *
 * 3. Neither the name of Analog Devices, Inc. nor the names of its
 *    contributors may be used to endorse or promote products derived from this
 *    software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY ANALOG DEVICES, INC. "AS IS" AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
 * EVENT SHALL ANALOG DEVICES, INC. BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
 * OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
******************************************************************************/
#ifndef GMSL_REG_ACCESS_H
#define GMSL_REG_ACCESS_H
 
#include <stdint.h>
#include "no_os_i2c.h"
 
#define RETURN_ON_ERR(x) if(x != 0) return (x)
 
#define REG_WRITE_RETURN_ON_ERR(ret, i2c_desc, reg, writeval) {\
    ret = gmsl_reg_write(i2c_desc, reg, writeval); \
    if(ret)\
        return ret;\
}
 
#define REG_READ_RETURN_ON_ERR(ret, i2c_desc, reg, mask, readval) {\
    ret = gmsl_reg_read(i2c_desc, reg, mask, readval); \
    if(ret)\
        return ret;\
}
 
#define REG_UPDATE_RETURN_ON_ERR(ret, i2c_desc, reg, val, mask) {\
    ret = gmsl_reg_update(i2c_desc, reg, val, mask); \
    if(ret)\
        return ret;\
}
 
#define BREAK_ON_ERR(x)\
if(x != 0)\
{\
    break;\
}
 
#define REG_WRITE_BREAK_ON_ERR(ret, i2c_desc, reg, writeval)\
{\
    ret = gmsl_reg_write(i2c_desc, reg, writeval);\
    BREAK_ON_ERR(ret);\
}
 
#define REG_READ_BREAK_ON_ERR(ret, i2c_desc, reg, mask, readval)\
{\
    ret = gmsl_reg_read(i2c_desc, reg, mask, readval);\
    BREAK_ON_ERR(ret);\
}
 
#define REG_UPDATE_BREAK_ON_ERR(ret, i2c_desc, reg, val, mask)\
{\
    ret = gmsl_reg_update(i2c_desc, reg, val, mask);\
    BREAK_ON_ERR(ret);\
}

int32_t gmsl_reg_read(struct no_os_i2c_desc *i2c_desc,
              uint16_t reg, uint8_t mask, uint8_t *readval);

int32_t gmsl_reg_write(struct no_os_i2c_desc *i2c_desc,
               uint16_t reg,
               uint8_t writeval);

int32_t gmsl_reg_update(struct no_os_i2c_desc *i2c_desc,
            uint16_t reg,
            uint8_t val,
            uint8_t mask);
 
#endif  /* GMSL_REG_ACCESS_H */