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 #include <stdint.h>
  41
  42 #include "maa.h"
  43 #include "gpio.h"
  44
  45 /**
  46  * Opaque pointer definition to the internal struct _i2c
  47  */
  48 typedef struct _i2c* maa_i2c_context;
  49
  50 /** Initialise i2c context, using board defintions
  51  *
  52  * @param bus i2c bus to use
  53  * @return maa_i2c_context i2c context ready for other calls.
  54  */
  55 maa_i2c_context maa_i2c_init(int bus);
  56
  57 /** Initialise i2c context, passing in spi bus to use.
  58  *
  59  * @param bus The i2c bus to use i.e. /dev/i2c-2 would be "2"
  60  * @return maa_i2c_context i2c context ready for other calls.
  61  */
  62 maa_i2c_context maa_i2c_init_raw(unsigned int bus);
  63
  64 /** Sets the frequency of the i2c context
  65  *
  66  *  @param dev the i2c context
  67  *  @param hz The bus frequency in hertz
  68  *
  69  *  @return maa_result_t the maa result.
  70  */
  71 maa_result_t maa_i2c_frequency(maa_i2c_context dev, int hz);
  72
  73 /** Read from an i2c context
  74  *
  75  *  @param dev the i2c context
  76  *  @param data pointer to the byte array to read data in to
  77  *  @param length max number of bytes to read
  78  *
  79  *  @return maa_result_t the maa result.
  80  */
  81 maa_result_t maa_i2c_read(maa_i2c_context dev, uint8_t *data, int length);
  82
  83 /** Read a single byte from the i2c context
  84  *
  85  *  @param dev the i2c context
  86  *
  87  *  @return byte the result of the read or -1 if failed.
  88  */
  89 uint8_t maa_i2c_read_byte(maa_i2c_context dev);
  90
  91 /** Write to an i2c context
  92  *
  93  *  @param dev the i2c context
  94  *  @param data pointer to the byte array to be written
  95  *  @param length the number of bytes to transmit
  96  *
  97  *  @return maa_result_t the maa result.
  98  */
  99 maa_result_t maa_i2c_write(maa_i2c_context dev, const uint8_t *data, int length);
 100
 101 /** Write a single byte to an i2c context
 102  *
 103  *  @param dev the i2c context
 104  *  @data the byte to write
 105  *
 106  *  @return maa_result_t the maa result.
 107  */
 108 maa_result_t maa_i2c_write_byte(maa_i2c_context dev, const uint8_t data);
 109
 110 /** Sets the i2c context address.
 111  *
 112  *  @param dev the i2c context
 113  *  @param address The address to set for the slave (ignoring the least
 114  *  signifcant bit). If set to 0, the slave will only respond to the
 115  *  general call address.
 116  *
 117  *  @return maa_result_t the maa result.
 118  */
 119 maa_result_t maa_i2c_address(maa_i2c_context dev, int address);
 120
 121 /** De-inits an maa_i2c_context device
 122  *
 123  *  @param dev the i2c context
 124  *
 125  *  @return maa_result_t the maa result.
 126  */
 127 maa_result_t maa_i2c_stop(maa_i2c_context dev);
 128
 129 #ifdef __cplusplus
 130 }
 131 #endif