FreeRTOS/Demo/CORTEX_A5_SAMA5D3x_Xplained_IAR/AtmelFiles/usb/include/CDCDSerialPort.h

/* ----------------------------------------------------------------------------
 *         ATMEL Microcontroller Software Support
 * ----------------------------------------------------------------------------
 * Copyright (c) 2010, Atmel Corporation
 *
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * - Redistributions of source code must retain the above copyright notice,
 * this list of conditions and the disclaimer below.
 *
 * Atmel's name may not be used to endorse or promote products derived from
 * this software without specific prior written permission.
 *
 * DISCLAIMER: THIS SOFTWARE IS PROVIDED BY ATMEL "AS IS" AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT ARE
 * DISCLAIMED. IN NO EVENT SHALL ATMEL BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
 * OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 * ----------------------------------------------------------------------------
 */

/** \file
 *  Definition of a class for implementing a USB device
 *  CDC serial port function.
 */

#ifndef _CDCDSERIALPORT_H_
#define _CDCDSERIALPORT_H_

/*------------------------------------------------------------------------------
 *         Headers
 *------------------------------------------------------------------------------*/
 
/* These headers were introduced in C99
   by working group ISO/IEC JTC1/SC22/WG14. */
#include <stdint.h>

#include <USBRequests.h>
#include <CDCRequests.h>
#include <CDCNotifications.h>
#include "USBD.h"
#include <USBDDriver.h>
/** \addtogroup usbd_cdc
 *@{
 */

/*------------------------------------------------------------------------------
 *         Defines
 *------------------------------------------------------------------------------*/

/** \addtogroup usbd_cdc_serial_desc USB Device Serial Port Descriptor Values
 *      @{
 */
/** Default CDC interrupt endpoints max packat size (8). */
#define CDCDSerialPort_INTERRUPT_MAXPACKETSIZE          8
/** Default CDC interrupt endpoint polling rate of High Speed (16ms). */
#define CDCDSerialPort_INTERRUPT_INTERVAL_HS            8
/** Default CDC interrupt endpoint polling rate of Full Speed (16ms). */
#define CDCDSerialPort_INTERRUPT_INTERVAL_FS            16
/** Default CDC bulk endpoints max packat size (512, for HS actually). */
#define CDCDSerialPort_BULK_MAXPACKETSIZE_HS            512
/** Default CDC bulk endpoints max packat size (64, for FS actually). */
#define CDCDSerialPort_BULK_MAXPACKETSIZE_FS            64
/**     @}*/

/** \addtogroup usbd_cdc_serial_events USB Device Serial Port Events
 *      @{
 */
/** SetControlLineState event, value is changed */
#define CDCDSerialPortEvent_SETCONTROLLINESTATE         0
/** SetLineCoding event, value is to changed according to return value */
#define CDCDSerialPortEvent_SETLINECODING               1
/**     @}*/

/*------------------------------------------------------------------------------
 *         Types
 *------------------------------------------------------------------------------*/

/** Callback function for serial port events */
typedef uint32_t (*CDCDSerialPortEventHandler)(uint32_t dwEvent,
                                               uint32_t dwParam,
                                               void * pArguments);

/**
 * Struct for USB CDC virtual COM serial port function.
 */
typedef struct _CDCDSerialPort {
    /** USB Driver for the %device */
    USBDDriver *pUsbd;
    /** Callback for serial port events */
    CDCDSerialPortEventHandler fEventHandler;
    /** Callback arguments */
    void *pArg;
    /** USB starting interface index */
    uint8_t bInterfaceNdx;
    /** USB number of interfaces */
    uint8_t bNumInterface;
    /** USB interrupt IN endpoint address */
    uint8_t bIntInPIPE;
    /** USB bulk IN endpoint address */
    uint8_t bBulkInPIPE;
    /** USB bulk OUT endpoint address */
    uint8_t bBulkOutPIPE;

    /** Serial port ControlLineState */
    uint8_t        bControlLineState;
    /** Serial port SerialState */
    uint16_t       wSerialState;
    /** Serial port linecoding */
    CDCLineCoding  lineCoding;

    uint8_t  bReserved;
} CDCDSerialPort;

/*------------------------------------------------------------------------------
 *         Functions
 *------------------------------------------------------------------------------*/

extern void CDCDSerialPort_Initialize(CDCDSerialPort *pCdcd,
                                      USBDDriver *pUsbd,
                                      CDCDSerialPortEventHandler fCallback,
                                      void *pArg,
                                      uint8_t firstInterface,
                                      uint8_t numInterface);

extern USBGenericDescriptor * CDCDSerialPort_ParseInterfaces(
    CDCDSerialPort * pCdcd,
    USBGenericDescriptor * pDescriptors, uint32_t dwLength);

extern uint32_t CDCDSerialPort_RequestHandler(
    CDCDSerialPort *pCdcd,
    const USBGenericRequest *pRequest);

extern uint32_t CDCDSerialPort_Write(
    const CDCDSerialPort *pCdcd,
    void *pData, uint32_t dwSize,
    TransferCallback fCallback, void* pArg);

extern uint32_t CDCDSerialPort_Read(
    const CDCDSerialPort *pCdcd,
    void *pData, uint32_t dwSize,
    TransferCallback fCallback, void* pArg);

extern uint16_t CDCDSerialPort_GetSerialState(
    const CDCDSerialPort *pCdcd);

extern void CDCDSerialPort_SetSerialState(
    CDCDSerialPort *pCdcd,
    uint16_t wSerialState);

extern uint8_t CDCDSerialPort_GetControlLineState(
    const CDCDSerialPort * pCdcd);

extern void CDCDSerialPort_GetLineCoding(
    const CDCDSerialPort * pCdcd,
    CDCLineCoding * pLineCoding);

/**@}*/
#endif /* #ifndef _CDCDSERIALPORT_H_ */