blob: 0f28220deb1b3b1f6de2ae7ce0c80b41259cebaa [file] [log] [blame]
Christina Quastb123d742014-12-23 13:03:36 +01001/* ----------------------------------------------------------------------------
2 * ATMEL Microcontroller Software Support
3 * ----------------------------------------------------------------------------
4 * Copyright (c) 2008, Atmel Corporation
5 *
6 * All rights reserved.
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions are met:
10 *
11 * - Redistributions of source code must retain the above copyright notice,
12 * this list of conditions and the disclaimer below.
13 *
14 * Atmel's name may not be used to endorse or promote products derived from
15 * this software without specific prior written permission.
16 *
17 * DISCLAIMER: THIS SOFTWARE IS PROVIDED BY ATMEL "AS IS" AND ANY EXPRESS OR
18 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
19 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT ARE
20 * DISCLAIMED. IN NO EVENT SHALL ATMEL BE LIABLE FOR ANY DIRECT, INDIRECT,
21 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
22 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
23 * OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
24 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
25 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
26 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 * ----------------------------------------------------------------------------
28 */
29
30/** \file
31 Implementation of the CDCLineCoding class.
32 */
33/** \addtogroup usb_cdc
34 *@{
35 */
36
37/*----------------------------------------------------------------------------
38 * Headers
39 *----------------------------------------------------------------------------*/
40
41#include <CDCRequests.h>
42
43/*----------------------------------------------------------------------------
44 * Exported functions
45 *----------------------------------------------------------------------------*/
46
47/**
48 * Initializes the bitrate, number of stop bits, parity checking and
49 * number of data bits of a CDCLineCoding object.
50 * \param lineCoding Pointer to a CDCLineCoding instance.
51 * \param bitrate Bitrate of the virtual COM connection.
52 * \param stopbits Number of stop bits
53 * (\ref usb_cdc_stop CDC LineCoding StopBits).
54 * \param parity Parity check type
55 * (\ref usb_cdc_parity CDC LineCoding ParityChecking).
56 * \param databits Number of data bits.
57 */
58void CDCLineCoding_Initialize(CDCLineCoding *lineCoding,
59 uint32_t bitrate,
60 uint8_t stopbits,
61 uint8_t parity,
62 uint8_t databits)
63{
64 lineCoding->dwDTERate = bitrate;
65 lineCoding->bCharFormat = stopbits;
66 lineCoding->bParityType = parity;
67 lineCoding->bDataBits = databits;
68}
69
70/**@}*/
71