SAMV71 Xplained Ultra Software Package 1.5

CDCLineCoding.c

Go to the documentation of this file.
00001 /* ---------------------------------------------------------------------------- */
00002 /*                  Atmel Microcontroller Software Support                      */
00003 /*                       SAM Software Package License                           */
00004 /* ---------------------------------------------------------------------------- */
00005 /* Copyright (c) 2015, Atmel Corporation                                        */
00006 /*                                                                              */
00007 /* All rights reserved.                                                         */
00008 /*                                                                              */
00009 /* Redistribution and use in source and binary forms, with or without           */
00010 /* modification, are permitted provided that the following condition is met:    */
00011 /*                                                                              */
00012 /* - Redistributions of source code must retain the above copyright notice,     */
00013 /* this list of conditions and the disclaimer below.                            */
00014 /*                                                                              */
00015 /* Atmel's name may not be used to endorse or promote products derived from     */
00016 /* this software without specific prior written permission.                     */
00017 /*                                                                              */
00018 /* DISCLAIMER:  THIS SOFTWARE IS PROVIDED BY ATMEL "AS IS" AND ANY EXPRESS OR   */
00019 /* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF */
00020 /* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT ARE   */
00021 /* DISCLAIMED. IN NO EVENT SHALL ATMEL BE LIABLE FOR ANY DIRECT, INDIRECT,      */
00022 /* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT */
00023 /* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,  */
00024 /* OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF    */
00025 /* LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING         */
00026 /* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, */
00027 /* EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.                           */
00028 /* ---------------------------------------------------------------------------- */
00029 
00030 /** \file
00031     Implementation of the CDCLineCoding class.
00032  */
00033 /** \addtogroup usb_cdc
00034  *@{
00035  */
00036 
00037 /*----------------------------------------------------------------------------
00038  *         Headers
00039  *----------------------------------------------------------------------------*/
00040 
00041 #include <CDCRequests.h>
00042 
00043 /*----------------------------------------------------------------------------
00044  *         Exported functions
00045  *----------------------------------------------------------------------------*/
00046 
00047 /**
00048  *  Initializes the bitrate, number of stop bits, parity checking and
00049  *  number of data bits of a CDCLineCoding object.
00050  *  \param lineCoding Pointer to a CDCLineCoding instance.
00051  *  \param bitrate Bitrate of the virtual COM connection.
00052  *  \param stopbits Number of stop bits
00053  *                  (\ref usb_cdc_stop CDC LineCoding StopBits).
00054  *  \param parity Parity check type
00055  *                  (\ref usb_cdc_parity CDC LineCoding ParityChecking).
00056  *  \param databits Number of data bits.
00057  */
00058 void CDCLineCoding_Initialize(CDCLineCoding *lineCoding,
00059                               uint32_t bitrate,
00060                               uint8_t stopbits,
00061                               uint8_t parity,
00062                               uint8_t databits)
00063 {
00064     lineCoding->dwDTERate = bitrate;
00065     lineCoding->bCharFormat = stopbits;
00066     lineCoding->bParityType = parity;
00067     lineCoding->bDataBits = databits;
00068 }
00069 
00070 /**@}*/
00071 
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Defines