api/i2c.h

   1 /*
   2  * Author: Brendan Le Foll <brendan.le.foll@intel.com>
   3  * Copyright (c) 2014 Intel Corporation.
   4  *
   5  * Permission is hereby granted, free of charge, to any person obtaining
   6  * a copy of this software and associated documentation files (the
   7  * "Software"), to deal in the Software without restriction, including
   8  * without limitation the rights to use, copy, modify, merge, publish,
   9  * distribute, sublicense, and/or sell copies of the Software, and to
  10  * permit persons to whom the Software is furnished to do so, subject to
  11  * the following conditions:
  12  *
  13  * The above copyright notice and this permission notice shall be
  14  * included in all copies or substantial portions of the Software.
  15  *
  16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  17  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  18  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  19  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  20  * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  21  * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  22  * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  23  */
  24
  25 #pragma once
  26
  27 /** @file
  28  *
  29  * This file defines the i2c interface for libmaa
  30  *
  31  */
  32
  33 #ifdef __cplusplus
  34 extern "C" {
  35 #endif
  36
  37 #include <stdlib.h>
  38 #include <stdio.h>
  39 #include <fcntl.h>
  40
  41 #include "maa.h"
  42 #include "gpio.h"
  43
  44 /**
  45  * A structure representing an i2c device /dev/i2c-*
  46  */
  47 typedef struct {
  48     /*@{*/
  49     int hz; /**< frequency of communication */
  50     int fh; /**< the file handle to the /dev/i2c-* device */
  51     int addr; /**< the address of the i2c slave */
  52     /*@}*/
  53 } maa_i2c_context;
  54
  55 maa_i2c_context* maa_i2c_init();
  56
  57 /** Sets the frequency of the i2c context
  58  *
  59  *  @param dev the i2c context
  60  *  @param hz The bus frequency in hertz
  61  *
  62  *  @return maa_result_t the maa result.
  63  */
  64 maa_result_t maa_i2c_frequency(maa_i2c_context* dev, int hz);
  65
  66 /** Read from an i2c context
  67  *
  68  *  @param dev the i2c context
  69  *  @param data pointer to the byte array to read data in to
  70  *  @param length max number of bytes to read
  71  *
  72  *  @return maa_result_t the maa result.
  73  */
  74 maa_result_t maa_i2c_read(maa_i2c_context* dev, char *data, int length);
  75
  76 /** Read a single byte from the i2c context
  77  *
  78  *  @param dev the i2c context
  79  *
  80  *  @return byte the result of the read or -1 if failed.
  81  */
  82 int maa_i2c_read_byte(maa_i2c_context* dev);
  83
  84 /** Write to an i2c context
  85  *
  86  *  @param dev the i2c context
  87  *  @param data pointer to the byte array to be written
  88  *  @param length the number of bytes to transmit
  89  *
  90  *  @return maa_result_t the maa result.
  91  */
  92 maa_result_t maa_i2c_write(maa_i2c_context* dev, const char *data, int length);
  93
  94 /** Write a single byte to an i2c context
  95  *
  96  *  @param dev the i2c context
  97  *  @data the byte to write
  98  *
  99  *  @return maa_result_t the maa result.
 100  */
 101 maa_result_t maa_i2c_write_byte(maa_i2c_context* dev, int data);
 102
 103 /** Sets the i2c context address.
 104  *
 105  *  @param dev the i2c context
 106  *  @param address The address to set for the slave (ignoring the least
 107  *  signifcant bit). If set to 0, the slave will only respond to the
 108  *  general call address.
 109  *
 110  *  @return maa_result_t the maa result.
 111  */
 112 maa_result_t maa_i2c_address(maa_i2c_context* dev, int address);
 113
 114 /** De-inits an maa_i2c_context device
 115  *
 116  *  @param dev the i2c context
 117  *
 118  *  @return maa_result_t the maa result.
 119  */
 120 maa_result_t maa_i2c_stop(maa_i2c_context* dev);
 121
 122 #ifdef __cplusplus
 123 }
 124 #endif