twi.h

Go to the documentation of this file.

/* Copyright 2015, Peter A. Bigot
 *
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * * Redistributions of source code must retain the above copyright notice,
 *   this list of conditions and the following disclaimer.
 *
 * * 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.
 *
 * * Neither the name of the software 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 THE COPYRIGHT HOLDERS AND CONTRIBUTORS "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 THE COPYRIGHT HOLDER OR CONTRIBUTORS 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 BSPACM_DEVICE_NRF51_INTERNAL_PERIPH_TWI_H
#define BSPACM_DEVICE_NRF51_INTERNAL_PERIPH_TWI_H

#include <bspacm/core.h>

/* Certain negative error codes convey information.  For those cases,
 * the absolute value is taken from the ERRORSRC register augmented by
 * several flags for other error conditions. */

#define BSPACM_NRF_TWI_BUS_ERROR_TIMEOUT 0x100

#define BSPACM_NRF_TWI_BUS_ERROR_CLEAR_FAILED 0x200

#define BSPACM_NRF_TWI_BUS_ERROR_UNKNOWN 0x400

#ifndef BSPACM_NRF_APPLY_PAN_36

#define BSPACM_NRF_APPLY_PAN_36 1
#endif /* BSPACM_NRF_APPLY_PAN_36 */

#ifndef BSPACM_NRF_APPLY_PAN_56

#define BSPACM_NRF_APPLY_PAN_56 1
#endif /* BSPACM_NRF_APPLY_PAN_56 */

#define BSPACM_I2C_MINIMUM_BUS_TIMEOUT_us 100

typedef struct sBSPACMi2cBus {
  NRF_TWI_Type * twi;

  unsigned int timeout_utt;

  uint32_t frequency;

  uint8_t sda_pin;

  uint8_t scl_pin;

#if (BSPACM_NRF_APPLY_PAN_36 - 0)

  int8_t ppi_chidx;
#endif /* BSPACM_NRF_APPLY_PAN_36 */
} sBSPACMi2cBus;

typedef const sBSPACMi2cBus * hBSPACMi2cBus;

hBSPACMi2cBus
hBSPACMi2cConfigureBus (sBSPACMi2cBus * tpp,
                        NRF_TWI_Type * twi,
                        int sda_pin,
                        int scl_pin,
                        int ppi_chidx,
                        uint32_t frequency,
                        unsigned int timeout_us);

int
iBSPACMi2cSetEnabled (hBSPACMi2cBus tpp,
                      bool enabled);

int
iBSPACMi2cRead (hBSPACMi2cBus tpp,
                unsigned int addr,
                uint8_t * dp,
                size_t len);

int
iBSPACMi2cWrite (hBSPACMi2cBus tpp,
                 unsigned int addr,
                 const uint8_t * sp,
                 size_t len);

#endif /* BSPACM_DEVICE_NRF51_INTERNAL_PERIPH_TWI_H */