source: rtems/c/src/lib/libbsp/arm/stm32f4/include/i2c.h @ 8224d2af

4.115
Last change on this file since 8224d2af was 8224d2af, checked in by Daniel Ramirez <javamonn@…>, on 12/22/13 at 21:55:40

arm_stm32f4: added new doxygen

  • Property mode set to 100644
File size: 2.1 KB
Line 
1/**
2 * @file
3 * @ingroup stm32f4_i2c I2C Support
4 * @brief I2C-module.
5 */
6
7/*
8 * Copyright (c) 2013 Christian Mauderer.  All rights reserved.
9 *
10 *  embedded brains GmbH
11 *  Obere Lagerstr. 30
12 *  82178 Puchheim
13 *  Germany
14 *  <rtems@embedded-brains.de>
15 *
16 * The license and distribution terms for this file may be
17 * found in the file LICENSE in this distribution or at
18 * http://www.rtems.com/license/LICENSE.
19 */
20
21/* The I2C-module can not run with libi2c. The reason for this is, that libi2c
22 * needs a possibility to generate a stop condition separately. This controller
23 * wants to generate the condition automatically when sending or receiving data.
24 */
25
26#ifndef LIBBSP_ARM_STM32F4_I2C_H
27#define LIBBSP_ARM_STM32F4_I2C_H
28
29#include <rtems.h>
30
31#include <bsp/io.h>
32#include <bsp/stm32f4.h>
33
34#ifdef __cplusplus
35extern "C" {
36#endif /* __cplusplus */
37
38/**
39 * @defgroup stm32f4_i2c I2C Support
40 * @ingroup arm_stm32f4
41 * @brief I2C Module
42 * @{
43 */
44
45typedef struct {
46  /**
47   * @brief The address of the slave without the read write bit.
48   * A 7-Bit address should be placed in the bits [6..0]
49   */
50  uint16_t addr;
51  /** @brief Read (true) or write (false) data */
52  bool read;
53  /** @brief Size of data to read or write */
54  size_t len;
55  /** @brief Buffer for data */
56  uint8_t *buf;
57} stm32f4_i2c_message;
58
59typedef struct {
60  volatile stm32f4_i2c *regs;
61  size_t index;
62  rtems_vector_number vector;
63  rtems_id mutex;
64  rtems_id task_id;
65  uint8_t *data;
66  uint8_t *last;
67  size_t len;
68  bool read;
69  uint8_t addr_with_rw;
70} stm32f4_i2c_bus_entry;
71
72/** @brief Initialise the i2c module. */
73rtems_status_code stm32f4_i2c_init(stm32f4_i2c_bus_entry *e);
74
75/** @brief Process a i2c message */
76rtems_status_code stm32f4_i2c_process_message(
77  stm32f4_i2c_bus_entry *e,
78  stm32f4_i2c_message *msg
79);
80
81/** @brief Set another baud rate than the default one */
82rtems_status_code stm32f4_i2c_set_bitrate(
83  stm32f4_i2c_bus_entry *e,
84  uint32_t br
85);
86
87extern stm32f4_i2c_bus_entry *const stm32f4_i2c1;
88extern stm32f4_i2c_bus_entry *const stm32f4_i2c2;
89
90/** @} */
91
92#ifdef __cplusplus
93}
94#endif /* __cplusplus */
95
96#endif /* LIBBSP_ARM_STM32F4_I2C_H */
Note: See TracBrowser for help on using the repository browser.