SAMV71 Xplained Ultra Software Package 1.3

CDCLineCoding.c

Go to the documentation of this file.
00001 /* ----------------------------------------------------------------------------
00002  *         SAM Software Package License
00003  * ----------------------------------------------------------------------------
00004  * Copyright (c) 2014, Atmel Corporation
00005  *
00006  * All rights reserved.
00007  *
00008  * Redistribution and use in source and binary forms, with or without
00009  * modification, are permitted provided that the following conditions are met:
00010  *
00011  * - Redistributions of source code must retain the above copyright notice,
00012  * this list of conditions and the disclaimer below.
00013  *
00014  * Atmel's name may not be used to endorse or promote products derived from
00015  * this software without specific prior written permission.
00016  *
00017  * DISCLAIMER: THIS SOFTWARE IS PROVIDED BY ATMEL "AS IS" AND ANY EXPRESS OR
00018  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
00019  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT ARE
00020  * DISCLAIMED. IN NO EVENT SHALL ATMEL BE LIABLE FOR ANY DIRECT, INDIRECT,
00021  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
00022  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
00023  * OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00024  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00025  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
00026  * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00027  * ----------------------------------------------------------------------------
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