OpenCores
URL https://opencores.org/ocsvn/gecko3/gecko3/trunk

Subversion Repositories gecko3

[/] [gecko3/] [trunk/] [GECKO3COM/] [gecko3com-fw/] [firmware/] [include/] [i2c.h] - Blame information for rev 32

Details | Compare with Previous | View Log

Line No. Rev Author Line
1 9 nussgipfel
/* -*- c++ -*- */
2
/*
3
 * Copyright 2003 Free Software Foundation, Inc.
4
 *
5
 * This file is part of GNU Radio
6
 *
7
 * GNU Radio is free software; you can redistribute it and/or modify
8
 * it under the terms of the GNU General Public License as published by
9
 * the Free Software Foundation; either version 3, or (at your option)
10
 * any later version.
11
 *
12
 * GNU Radio is distributed in the hope that it will be useful,
13
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15
 * GNU General Public License for more details.
16
 *
17
 * You should have received a copy of the GNU General Public License
18
 * along with GNU Radio; see the file COPYING.  If not, write to
19
 * the Free Software Foundation, Inc., 51 Franklin Street,
20
 * Boston, MA 02110-1301, USA.
21
 */
22
 
23
/************************************************************************/
24
/** \file         i2c.h
25
 *************************************************************************
26
 *  \brief        read and write functions for the i2c bus
27
 *
28
 *  \author       GNU Radio
29
 *
30
 *  \warning      This functions are blocking functions, so you have to wait
31
 *                until the transfer is finished!
32
 */
33
 
34
#ifndef _I2C_H_
35
#define _I2C_H_
36
 
37
/**
38
 * i2c read function. reads a block of data with the length len
39
 *
40 32 nussgipfel
 * \param[in] addr device adress on the i2c bus
41 9 nussgipfel
 * \param[out] buf result buffer, contains the readed data when successful
42
 * \param[in] len length of the block to read
43
 * \return returns non-zero if successful, else 0
44
 */
45
unsigned char i2c_read (unsigned char addr, xdata unsigned char *buf, unsigned char len);
46
 
47
/**
48
 * i2c write function. writes a block of data with the length len
49
 *
50 32 nussgipfel
 * \param[in] addr device adress on the i2c bus
51 9 nussgipfel
 * \param[in] buf data buffer, contains the data to be written
52
 * \param[in] len length of the block to write
53
 * \return returns non-zero if successful, else 0
54
 */
55
unsigned char i2c_write (unsigned char addr, xdata const unsigned char *buf, unsigned char len);
56
 
57
#endif /* _I2C_H_ */

powered by: WebSVN 2.1.0

© copyright 1999-2024 OpenCores.org, equivalent to Oliscience, all rights reserved. OpenCores®, registered trademark.