tinySA/os/hal/dox/i2s.dox

/*
    ChibiOS - Copyright (C) 2006..2016 Giovanni Di Sirio

    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.
    You may obtain a copy of the License at

        http://www.apache.org/licenses/LICENSE-2.0

    Unless required by applicable law or agreed to in writing, software
    distributed under the License is distributed on an "AS IS" BASIS,
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
    limitations under the License.
*/

/**
 * @defgroup I2S I2S Driver
 * @brief   Generic I2S Driver.
 * @details This module implements a generic I2S  driver.
 * @pre     In order to use the I2S driver the @p HAL_USE_I2S option
 *          must be enabled in @p halconf.h.
 *
 * @section i2s_1 Driver State Machine
 *
 * @ingroup HAL_NORMAL_DRIVERS
 */