aboutsummaryrefslogtreecommitdiffstats
path: root/os/hal/src/i2s.c
blob: 4eecfffbf6c3546cf6afbff3f0e23420f970e1f5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
/*
    ChibiOS/RT - Copyright (C) 2006,2007,2008,2009,2010,
                 2011,2012 Giovanni Di Sirio.

    This file is part of ChibiOS/RT.

    ChibiOS/RT is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 3 of the License, or
    (at your option) any later version.

    ChibiOS/RT is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/

/**
 * @file    i2s.c
 * @brief   I2S Driver code.
 *
 * @addtogroup I2S
 * @{
 */

#include "ch.h"
#include "hal.h"

#if HAL_USE_I2S || defined(__DOXYGEN__)

/*===========================================================================*/
/* Driver local definitions.                                                 */
/*===========================================================================*/

/*===========================================================================*/
/* Driver exported variables.                                                */
/*===========================================================================*/

/*===========================================================================*/
/* Driver local variables.                                                   */
/*===========================================================================*/

/*===========================================================================*/
/* Driver local functions.                                                   */
/*===========================================================================*/

/*===========================================================================*/
/* Driver exported functions.                                                */
/*===========================================================================*/

/**
 * @brief   I2S Driver initialization.
 * @note    This function is implicitly invoked by @p halInit(), there is
 *          no need to explicitly initialize the driver.
 *
 * @init
 */
void i2sInit(void) {

  i2s_lld_init();
}

/**
 * @brief   Initializes the standard part of a @p I2SDriver structure.
 *
 * @param[out] i2sp     pointer to the @p I2SDriver object
 *
 * @init
 */
void i2sObjectInit(I2SDriver *i2sp) {

  i2sp->state  = I2S_STOP;
  i2sp->config = NULL;
}

/**
 * @brief   Configures and activates the I2S peripheral.
 *
 * @param[in] i2sp      pointer to the @p I2SDriver object
 * @param[in] config    pointer to the @p I2SConfig object
 *
 * @api
 */
void i2sStart(I2SDriver *i2sp, const I2SConfig *config) {

  chDbgCheck((i2sp != NULL) && (config != NULL), "i2sStart");

  chSysLock();
  chDbgAssert((i2sp->state == I2S_STOP) || (i2sp->state == I2S_READY),
              "i2sStart(), #1", "invalid state");
  i2sp->config = config;
  i2s_lld_start(i2sp);
  i2sp->state = I2S_READY;
  chSysUnlock();
}

/**
 * @brief   Deactivates the I2S peripheral.
 *
 * @param[in] i2sp      pointer to the @p I2SDriver object
 *
 * @api
 */
void i2sStop(I2SDriver *i2sp) {

  chDbgCheck(i2sp != NULL, "i2sStop");

  chSysLock();
  chDbgAssert((i2sp->state == I2S_STOP) || (i2sp->state == I2S_READY),
              "i2sStop(), #1", "invalid state");
  i2s_lld_stop(i2sp);
  i2sp->state = I2S_STOP;
  chSysUnlock();
}

/**
 * @brief   Starts a I2S transmission.
 * @details The transmission is started and it is executes until the specified
 *          buffer has entirely transmitted.
 * @post    A callback is invoked when the buffer has been fully transmitted.
 *
 * @param[in] i2sp      pointer to the @p I2SDriver object
 * @param[in] n         number of samples to send
 * @param[in] txbuf     the pointer to the transmit buffer
 *
 * @api
 */
void i2sStartSendOnce(I2SDriver *i2sp, size_t n,
                      const i2ssample_t *txbuf) {

  chDbgCheck((i2sp != NULL) && (n > 0) && (txbuf != NULL),
             "i2sStartSendOnce");

  chSysLock();
  chDbgAssert(i2sp->state == I2S_READY, "i2sStartSendOnce(), #1",
              "not ready");
  i2sStartSendOnceI(i2sp, n, txbuf);
  chSysUnlock();
}

/**
 * @brief   Starts a continuous I2S transmission.
 * @details The transmission is started and it is executes continuously
 *          until @p i2sStopSend() has been explicitly invoked .
 * @post    A callback is invoked when the buffer has been half transmitted
 *          and fully transmitted.
 *
 * @param[in] i2sp      pointer to the @p I2SDriver object
 * @param[in] n         number of samples to send
 * @param[in] txbuf     the pointer to the transmit buffer
 *
 * @api
 */
void i2sStartSendContinuous(I2SDriver *i2sp, size_t n,
                            const i2ssample_t *txbuf) {

  chDbgCheck((i2sp != NULL) && (n > 0) && (txbuf != NULL),
             "i2sStartSendContinuous");

  chSysLock();
  chDbgAssert(i2sp->state == I2S_READY, "i2sStartSendContinuous(), #1",
              "not ready");
  i2sStartSendContinuousI(i2sp, n, txbuf);
  chSysUnlock();
}

/**
 * @brief   Stops the ongoing transmission.
 * @details The ongoing transmission, if any, is stopped, if the driver
 *          was not transmitting the function does nothing.
 *
 * @param[in] i2sp      pointer to the @p I2SDriver object
 *
 * @api
 */
void i2sStopSend(I2SDriver *i2sp) {

  chDbgCheck((i2sp != NULL), "i2sStopSend");

  chSysLock();
  chDbgAssert((i2sp->state == I2S_READY) ||
              (i2sp->state == I2S_ACTIVE) ||
              (i2sp->state == I2S_COMPLETE),
              "i2sStopSend(), #1", "not ready");
  i2sStopSendI(i2sp);
  chSysUnlock();
}

#endif /* HAL_USE_I2S */

/** @} */