/*This file is prepared for Doxygen automatic documentation generation.*/
/*! \file *********************************************************************
 *
 * \brief USB Standard I/O Serial Management.
 *
 * This file defines a useful set of functions for the Stdio Serial interface on AVR 
 * devices.
 *
 *
 * \author               Atmel Corporation: http://www.atmel.com \n
 *                       Support and FAQ: http://support.atmel.no/
 *
 ******************************************************************************/

/* Copyright (c) 2011 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:
 *
 * 1. Redistributions of source code must retain the above copyright notice,
 * this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following disclaimer in the documentation
 * and/or other materials provided with the distribution.
 *
 * 3. The name of Atmel may not be used to endorse or promote products derived
 * from this software without specific prior written permission.
 *
 * 4. This software may only be redistributed and used in connection with an
 * Atmel AVR product.
 *
 * 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
 * EXPRESSLY AND SPECIFICALLY 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.
 */

#ifndef _stdio_usb_h_
#define _stdio_usb_h_

#include <asf.h>
#include <udc.h>

#include <stdio.h>

#if defined(XMEGA) && defined(__GNUC__)
    extern int _write (char c, int *f);
    extern int _read (int *f);
#endif


//! Pointer to the base of the USART module instance to use for stdio.
extern volatile void *volatile stdio_base;
//! Pointer to the external low level write function.
extern int (*ptr_put)(void volatile*,int);
//! Pointer to the external low level read function.
extern void (*ptr_get)(void volatile*,int*);

//! \internal User-defined callback for VBUS level change event.
extern void udc_vbus_action (bool b_high);

/*! \brief Sends a character with the USART.
 *
 * \param usart   Base address of the USART instance.
 * \param data    Character to write.
 *
 * \return Status.
 *   \retval  0  The character was written.
 *   \retval -1  The function timed out before the transmitter became ready.
 */
extern int stdio_usb_putchar (volatile void * usart, int data);

/*! \brief Waits until a character is received, and returns it.
 *
 * \param usart   Base address of the USART instance.
 * \param data    Data to read
 *
 * \return Nothing.
 */
extern void stdio_usb_getchar (void volatile * usart, int * data);

/*! \brief Initializes the stdio in USB Serial Mode.
 *
 * \return Nothing.
 */
static inline void stdio_usb_init (volatile void * usart)
    {
    stdio_base = usart;
    ptr_put = stdio_usb_putchar;
    ptr_get = stdio_usb_getchar;
    //
    // Start and attach USB CDC device interface for devices with
    // integrated USB interfaces.  Assume the VBUS is present if
    // VBUS monitoring is not available.
    //
    udc_start ();

    if (! udc_include_vbus_monitoring ()) {
        udc_vbus_action (true);
    }
    //
    // For AVR GCC libc print redirection uses fdevopen.
    //
    #if defined(XMEGA) && defined(__GNUC__)
        fdevopen((int (*)(char, FILE*))(_write),(int (*)(FILE*))(_read));
    #endif
    }

#endif  // _stdio_usb_h_
