Vijayaraghavan Narayanan / VLX6180X_API

vlx lib

i2c_log.h@0:bc9f26b5dadf, 2015-02-08 (annotated)

Committer:
vijaynvr
Date:
Sun Feb 08 14:26:51 2015 +0000
Revision:
0:bc9f26b5dadf
working

Who changed what in which revision?

UserRevisionLine numberNew contents of line
vijaynvr 0:bc9f26b5dadf 1 /*******************************************************************************
vijaynvr 0:bc9f26b5dadf 2 ################################################################################
vijaynvr 0:bc9f26b5dadf 3 # (C) STMicroelectronics 2014
vijaynvr 0:bc9f26b5dadf 4 #
vijaynvr 0:bc9f26b5dadf 5 # This program is free software; you can redistribute it and/or modify it under
vijaynvr 0:bc9f26b5dadf 6 # the terms of the GNU General Public License version 2 and only version 2 as
vijaynvr 0:bc9f26b5dadf 7 # published by the Free Software Foundation.
vijaynvr 0:bc9f26b5dadf 8 #
vijaynvr 0:bc9f26b5dadf 9 # This program is distributed in the hope that it will be useful, but WITHOUT
vijaynvr 0:bc9f26b5dadf 10 # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
vijaynvr 0:bc9f26b5dadf 11 # FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
vijaynvr 0:bc9f26b5dadf 12 # details.
vijaynvr 0:bc9f26b5dadf 13 #
vijaynvr 0:bc9f26b5dadf 14 # You should have received a copy of the GNU General Public License along with
vijaynvr 0:bc9f26b5dadf 15 # this program; if not, write to the Free Software Foundation, Inc.,
vijaynvr 0:bc9f26b5dadf 16 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
vijaynvr 0:bc9f26b5dadf 17 #
vijaynvr 0:bc9f26b5dadf 18 #------------------------------------------------------------------------------
vijaynvr 0:bc9f26b5dadf 19 # Imaging Division
vijaynvr 0:bc9f26b5dadf 20 ################################################################################
vijaynvr 0:bc9f26b5dadf 21 ********************************************************************************/
vijaynvr 0:bc9f26b5dadf 22
vijaynvr 0:bc9f26b5dadf 23 /*!
vijaynvr 0:bc9f26b5dadf 24 *\file i2c_log.h
vijaynvr 0:bc9f26b5dadf 25 *\brief I2C logging functionality.
vijaynvr 0:bc9f26b5dadf 26 */
vijaynvr 0:bc9f26b5dadf 27
vijaynvr 0:bc9f26b5dadf 28 #include "platform.h"
vijaynvr 0:bc9f26b5dadf 29
vijaynvr 0:bc9f26b5dadf 30 /*!
vijaynvr 0:bc9f26b5dadf 31 * \brief Function to Start logging all I2C activities
vijaynvr 0:bc9f26b5dadf 32 *
vijaynvr 0:bc9f26b5dadf 33 * All I2C access activity will be logged once this function is called.
vijaynvr 0:bc9f26b5dadf 34 * This function shall be called when debug level is set to I2C_LOG_LEVEL.
vijaynvr 0:bc9f26b5dadf 35 * \retval none
vijaynvr 0:bc9f26b5dadf 36 */
vijaynvr 0:bc9f26b5dadf 37 void i2c_log_start();
vijaynvr 0:bc9f26b5dadf 38
vijaynvr 0:bc9f26b5dadf 39 /*!
vijaynvr 0:bc9f26b5dadf 40 * \brief Function to Stop logging all I2C activities
vijaynvr 0:bc9f26b5dadf 41 *
vijaynvr 0:bc9f26b5dadf 42 * All I2C access activity will stop to be logged once this function is called.
vijaynvr 0:bc9f26b5dadf 43 * This function shall be called when debug level is set to I2C_LOG_LEVEL.
vijaynvr 0:bc9f26b5dadf 44 * \retval none
vijaynvr 0:bc9f26b5dadf 45 */
vijaynvr 0:bc9f26b5dadf 46 void i2c_log_end();
vijaynvr 0:bc9f26b5dadf 47
vijaynvr 0:bc9f26b5dadf 48 /*!
vijaynvr 0:bc9f26b5dadf 49 *\brief Function to output an I2C read transaction for a single byte to log file.
vijaynvr 0:bc9f26b5dadf 50 *
vijaynvr 0:bc9f26b5dadf 51 *\param[in] value data value read.
vijaynvr 0:bc9f26b5dadf 52 *\param[in] regOffset I2C register identifier.
vijaynvr 0:bc9f26b5dadf 53 *\retval none
vijaynvr 0:bc9f26b5dadf 54 */
vijaynvr 0:bc9f26b5dadf 55 void i2c_log_outputReadByteMsg(uint8_t value, uint32_t regOffset);
vijaynvr 0:bc9f26b5dadf 56
vijaynvr 0:bc9f26b5dadf 57 /*!
vijaynvr 0:bc9f26b5dadf 58 *\brief Function to output an I2C read transaction for a single word to log file.
vijaynvr 0:bc9f26b5dadf 59 *
vijaynvr 0:bc9f26b5dadf 60 *\param[in] value data value read.
vijaynvr 0:bc9f26b5dadf 61 *\param[in] regOffset I2C register identifier.
vijaynvr 0:bc9f26b5dadf 62 *\retval none
vijaynvr 0:bc9f26b5dadf 63 */
vijaynvr 0:bc9f26b5dadf 64 void i2c_log_outputReadWordMsg(uint16_t value, uint32_t regOffset);
vijaynvr 0:bc9f26b5dadf 65
vijaynvr 0:bc9f26b5dadf 66 /*!
vijaynvr 0:bc9f26b5dadf 67 *\brief Function to output an I2C read transaction for a single int to log file.
vijaynvr 0:bc9f26b5dadf 68 *
vijaynvr 0:bc9f26b5dadf 69 *\param[in] value data value read.
vijaynvr 0:bc9f26b5dadf 70 *\param[in] regOffset I2C register identifier.
vijaynvr 0:bc9f26b5dadf 71 *\retval none
vijaynvr 0:bc9f26b5dadf 72 */
vijaynvr 0:bc9f26b5dadf 73 void i2c_log_outputReadIntMsg(uint32_t value, uint32_t regOffset);
vijaynvr 0:bc9f26b5dadf 74
vijaynvr 0:bc9f26b5dadf 75 /*!
vijaynvr 0:bc9f26b5dadf 76 *\brief Function to output an I2C read transaction for an array of bytes to log file.
vijaynvr 0:bc9f26b5dadf 77 *
vijaynvr 0:bc9f26b5dadf 78 *\param[in] data data values read.
vijaynvr 0:bc9f26b5dadf 79 *\param[in] regOffset I2C register identifier.
vijaynvr 0:bc9f26b5dadf 80 *\param[in] size size of the data buffer.
vijaynvr 0:bc9f26b5dadf 81 *\retval none
vijaynvr 0:bc9f26b5dadf 82 */
vijaynvr 0:bc9f26b5dadf 83 void i2c_log_outputReadMsg(uint8_t *data, uint32_t regOffset, int32_t size);
vijaynvr 0:bc9f26b5dadf 84
vijaynvr 0:bc9f26b5dadf 85 /*!
vijaynvr 0:bc9f26b5dadf 86 *\brief Function to output an I2C write transaction for a single byte to log file.
vijaynvr 0:bc9f26b5dadf 87 *
vijaynvr 0:bc9f26b5dadf 88 *\param[in] data data value written.
vijaynvr 0:bc9f26b5dadf 89 *\param[in] regOffset I2C register identifier.
vijaynvr 0:bc9f26b5dadf 90 *\retval none
vijaynvr 0:bc9f26b5dadf 91 */
vijaynvr 0:bc9f26b5dadf 92 void i2c_log_outputWriteByteMsg(uint8_t data, uint32_t regOffset);
vijaynvr 0:bc9f26b5dadf 93
vijaynvr 0:bc9f26b5dadf 94 /*!
vijaynvr 0:bc9f26b5dadf 95 *\brief Function to output an I2C write transaction for a single byte to log file.
vijaynvr 0:bc9f26b5dadf 96 *
vijaynvr 0:bc9f26b5dadf 97 *\param[in] data data value written.
vijaynvr 0:bc9f26b5dadf 98 *\param[in] regOffset I2C register identifier.
vijaynvr 0:bc9f26b5dadf 99 *\retval none
vijaynvr 0:bc9f26b5dadf 100 */
vijaynvr 0:bc9f26b5dadf 101 void i2c_log_outputWriteWordMsg(uint16_t data, uint32_t regOffset);
vijaynvr 0:bc9f26b5dadf 102
vijaynvr 0:bc9f26b5dadf 103 /*!
vijaynvr 0:bc9f26b5dadf 104 *\brief Function to output an I2C write transaction for a single byte to log file.
vijaynvr 0:bc9f26b5dadf 105 *
vijaynvr 0:bc9f26b5dadf 106 *\param[in] data data value written.
vijaynvr 0:bc9f26b5dadf 107 *\param[in] regOffset I2C register identifier.
vijaynvr 0:bc9f26b5dadf 108 *\retval none
vijaynvr 0:bc9f26b5dadf 109 */
vijaynvr 0:bc9f26b5dadf 110 void i2c_log_outputWriteintMsg(uint32_t data, uint32_t regOffset);
vijaynvr 0:bc9f26b5dadf 111
vijaynvr 0:bc9f26b5dadf 112 /*!
vijaynvr 0:bc9f26b5dadf 113 *\brief Function to output an I2C write transaction for an array of bytes to log file.
vijaynvr 0:bc9f26b5dadf 114 *
vijaynvr 0:bc9f26b5dadf 115 *\param[in] value data values written.
vijaynvr 0:bc9f26b5dadf 116 *\param[in] regOffset I2C register identifier.
vijaynvr 0:bc9f26b5dadf 117 *\param[in] size size of the data buffer.
vijaynvr 0:bc9f26b5dadf 118 *\retval none
vijaynvr 0:bc9f26b5dadf 119 */
vijaynvr 0:bc9f26b5dadf 120 void i2c_log_outputWriteMsg(uint8_t *value, uint32_t regOffset, int32_t size);
vijaynvr 0:bc9f26b5dadf 121
vijaynvr 0:bc9f26b5dadf 122