include/bsp/atsam-i2c.h

0001 /* SPDX-License-Identifier: BSD-2-Clause */
0002
0003 /*
0004  * Copyright (c) 2016 embedded brains GmbH & Co. KG
0005  *
0006  * Redistribution and use in source and binary forms, with or without
0007  * modification, are permitted provided that the following conditions
0008  * are met:
0009  * 1. Redistributions of source code must retain the above copyright
0010  *    notice, this list of conditions and the following disclaimer.
0011  * 2. Redistributions in binary form must reproduce the above copyright
0012  *    notice, this list of conditions and the following disclaimer in the
0013  *    documentation and/or other materials provided with the distribution.
0014  *
0015  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
0016  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
0017  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
0018  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
0019  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
0020  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
0021  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
0022  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
0023  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
0024  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
0025  * POSSIBILITY OF SUCH DAMAGE.
0026  */
0027
0028 #ifndef LIBBSP_ARM_ATSAM_ATSAM_I2C_H
0029 #define LIBBSP_ARM_ATSAM_ATSAM_I2C_H
0030
0031 #include <libchip/chip.h>
0032 #include <libchip/include/pio.h>
0033
0034 #include <bsp.h>
0035 #include <rtems/thread.h>
0036 #include <dev/i2c/i2c.h>
0037
0038 #ifdef __cplusplus
0039 extern "C" {
0040 #endif /* __cplusplus */
0041
0042 #define TWI_AMOUNT_PINS 2
0043
0044 typedef struct {
0045     i2c_bus base;
0046     Twihs *regs;
0047
0048     /* First message and number of messages that have to be processed. */
0049     i2c_msg *msgs;
0050     uint32_t msg_todo;
0051
0052     /* Information about the current transfer. */
0053     bool stop_request;
0054     uint32_t current_msg_todo;
0055     uint8_t *current_msg_byte;
0056
0057     /* Error information that can be returned to the task */
0058     uint32_t err;
0059
0060     uint32_t output_clock;
0061     rtems_binary_semaphore sem;
0062     rtems_vector_number irq;
0063 } atsam_i2c_bus;
0064
0065 int i2c_bus_register_atsam(
0066     const char *bus_path,
0067     Twihs *register_base,
0068     rtems_vector_number irq,
0069     const Pin pins[TWI_AMOUNT_PINS]
0070 );
0071
0072 #ifdef __cplusplus
0073 }
0074 #endif /* __cplusplus */
0075
0076 #endif /* LIBBSP_ARM_ATSAM_ATSAM_I2C_H */