/***************************************************************************
 * A copy of the GNU GPL is appended to this file.                         *
 *                                                                         *
 * This licence is based on the nmap licence, and we express our gratitude *
 * for the work that went into producing it. There is no other connection  *
 * between RFIDler and nmap either expressed or implied.                   *
 *                                                                         *
 ********************** IMPORTANT RFIDler LICENSE TERMS ********************
 *                                                                         *
 *                                                                         *
 * All references to RFIDler herein imply all it's derivatives, namely:    *
 *                                                                         *
 * o RFIDler-LF Standard                                                   *
 * o RFIDler-LF Lite                                                       *
 * o RFIDler-LF Nekkid                                                     *
 *                                                                         *
 *                                                                         *
 * RFIDler is (C) 2013-2014 Aperture Labs Ltd.                             *
 *                                                                         *
 * This program is free software; you may redistribute and/or modify it    *
 * under the terms of the GNU General Public License as published by the   *
 * Free Software Foundation; Version 2 ("GPL"), BUT ONLY WITH ALL OF THE   *
 * CLARIFICATIONS AND EXCEPTIONS DESCRIBED HEREIN.  This guarantees your   *
 * right to use, modify, and redistribute this software under certain      *
 * conditions.  If you wish to embed RFIDler technology into proprietary   *
 * software or hardware, we sell alternative licenses                      *
 * (contact sales@aperturelabs.com).                                       *
 *                                                                         *
 * Note that the GPL places important restrictions on "derivative works",  *
 * yet it does not provide a detailed definition of that term.  To avoid   *
 * misunderstandings, we interpret that term as broadly as copyright law   *
 * allows.  For example, we consider an application to constitute a        *
 * derivative work for the purpose of this license if it does any of the   *
 * following with any software or content covered by this license          *
 * ("Covered Software"):                                                   *
 *                                                                         *
 * o Integrates source code from Covered Software.                         *
 *                                                                         *
 * o Is designed specifically to execute Covered Software and parse the    *
 * results (as opposed to typical shell or execution-menu apps, which will *
 * execute anything you tell them to).                                     *
 *                                                                         *
 * o Includes Covered Software in a proprietary executable installer.  The *
 * installers produced by InstallShield are an example of this.  Including *
 * RFIDler with other software in compressed or archival form does not     *
 * trigger this provision, provided appropriate open source decompression  *
 * or de-archiving software is widely available for no charge.  For the    *
 * purposes of this license, an installer is considered to include Covered *
 * Software even if it actually retrieves a copy of Covered Software from  *
 * another source during runtime (such as by downloading it from the       *
 * Internet).                                                              *
 *                                                                         *
 * o Links (statically or dynamically) to a library which does any of the  *
 * above.                                                                  *
 *                                                                         *
 * o Executes a helper program, module, or script to do any of the above.  *
 *                                                                         *
 * This list is not exclusive, but is meant to clarify our interpretation  *
 * of derived works with some common examples.  Other people may interpret *
 * the plain GPL differently, so we consider this a special exception to   *
 * the GPL that we apply to Covered Software.  Works which meet any of     *
 * these conditions must conform to all of the terms of this license,      *
 * particularly including the GPL Section 3 requirements of providing      *
 * source code and allowing free redistribution of the work as a whole.    *
 *                                                                         *
 * As another special exception to the GPL terms, Aperture Labs Ltd. grants*
 * permission to link the code of this program with any version of the     *
 * OpenSSL library which is distributed under a license identical to that  *
 * listed in the included docs/licenses/OpenSSL.txt file, and distribute   *
 * linked combinations including the two.                                  *
 *                                                                         *
 * Any redistribution of Covered Software, including any derived works,    *
 * must obey and carry forward all of the terms of this license, including *
 * obeying all GPL rules and restrictions.  For example, source code of    *
 * the whole work must be provided and free redistribution must be         *
 * allowed.  All GPL references to "this License", are to be treated as    *
 * including the terms and conditions of this license text as well.        *
 *                                                                         *
 * Because this license imposes special exceptions to the GPL, Covered     *
 * Work may not be combined (even as part of a larger work) with plain GPL *
 * software.  The terms, conditions, and exceptions of this license must   *
 * be included as well.  This license is incompatible with some other open *
 * source licenses as well.  In some cases we can relicense portions of    *
 * RFIDler or grant special permissions to use it in other open source     *
 * software.  Please contact sales@aperturelabs.com with any such requests.*
 * Similarly, we don't incorporate incompatible open source software into  *
 * Covered Software without special permission from the copyright holders. *
 *                                                                         *
 * If you have any questions about the licensing restrictions on using     *
 * RFIDler in other works, are happy to help.  As mentioned above, we also *
 * offer alternative license to integrate RFIDler into proprietary         *
 * applications and appliances.  These contracts have been sold to dozens  *
 * of software vendors, and generally include a perpetual license as well  *
 * as providing for priority support and updates.  They also fund the      *
 * continued development of RFIDler.  Please email sales@aperturelabs.com  *
 * for further information.                                                *
 * If you have received a written license agreement or contract for        *
 * Covered Software stating terms other than these, you may choose to use  *
 * and redistribute Covered Software under those terms instead of these.   *
 *                                                                         *
 * Source is provided to this software because we believe users have a     *
 * right to know exactly what a program is going to do before they run it. *
 * This also allows you to audit the software for security holes (none     *
 * have been found so far).                                                *
 *                                                                         *
 * Source code also allows you to port RFIDler to new platforms, fix bugs, *
 * and add new features.  You are highly encouraged to send your changes   *
 * to the RFIDler mailing list for possible incorporation into the         *
 * main distribution.  By sending these changes to Aperture Labs Ltd. or   *
 * one of the Aperture Labs Ltd. development mailing lists, or checking    *
 * them into the RFIDler source code repository, it is understood (unless  *
 * you specify otherwise) that you are offering the RFIDler Project        *
 * (Aperture Labs Ltd.) the unlimited, non-exclusive right to reuse,       *
 * modify, and relicense the code.  RFIDler will always be available Open  *
 * Source, but this is important because the inability to relicense code   *
 * has caused devastating problems for other Free Software projects (such  *
 * as KDE and NASM).  We also occasionally relicense the code to third     *
 * parties as discussed above. If you wish to specify special license      *
 * conditions of your contributions, just say so when you send them.       *
 *                                                                         *
 * This program is distributed in the hope that it will be useful, but     *
 * WITHOUT ANY WARRANTY; without even the implied warranty of              *
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the RFIDler   *
 * license file for more details (it's in a COPYING file included with     *
 * RFIDler, and also available from                                        *
 *   https://github.com/ApertureLabsLtd/RFIDler/COPYING                    *
 *                                                                         *
 ***************************************************************************/

// Author: Adam Laurie <adam@aperturelabs.com>



// external comms routines:
//
// USB CDC for CLI & API
// reader output - will send data to appropriate channels according to user selected options

#include "HardwareProfile.h"
#include "USB/usb.h"
#include "USB/usb_device.h"
#include "USB/usb_function_cdc.h"
#include "rfidler.h"
#include "uart3.h"
#include "comms.h"

// counter used by comms status as a global so external routines can use it for rudimentary entropy
unsigned int Led_Count= 0;

// master user messaging - this routine will message to current I/O method
// (USB or UART)
void UserMessage(BYTE *format, BYTE *message)
{
    BYTE tmp[TMP_SMALL_BUFF_LEN];

    snprintf(tmp, TMP_SMALL_BUFF_LEN, format, message);
    if(CommsChannel == COMMS_USB)
        SendUSBMessage(tmp, strlen(tmp));
    if(CommsChannel == COMMS_UART)
        SendUART3Message(tmp, strlen(tmp));
}

// send raw binary
void UserBinary(char *message, unsigned int length)
{
    if(CommsChannel == COMMS_USB)
        SendUSBMessage(message, length);
    if(CommsChannel == COMMS_UART)
        SendUART3Message(message, length);
}

// send raw binary byte
void UserBinaryByte(BYTE message)
{
    if(CommsChannel == COMMS_USB)
        SendUSBMessage(&message, 1);
    if(CommsChannel == COMMS_UART)
        SendUART3Message(&message, 1);
}

void UserMessageNum(BYTE *message, unsigned long num)
{
    BYTE tmp[TMP_SMALL_BUFF_LEN];

    sprintf(tmp, message, num);

    if(CommsChannel == COMMS_USB)
        UserMessage("%s", tmp);
}

// FIXME: implement for serial comms
BYTE GetUserMessage(char *buffer, BYTE len)
{
    if(CommsChannel == COMMS_USB)
    {
        if (mUSBUSARTIsTxTrfReady())
            return getsUSBUSART(buffer, len);
        else
            return 0;
    }
    return 0;
}

void SendUART3Message(unsigned char *message, unsigned int len)
{
    while (len--)
         UART3PutChar(*(message++));
}

// read bytes from UART and return after timeout - set timeout to something reasonably
// small so higher level routine can capture single keystrokes without feeling klunky
unsigned int GetUART3Message(unsigned char *message, unsigned int timeout)
{
    unsigned int time;
    unsigned char p= 0;

    // make sure we return a NULL string if we timeout
    *message= '\0';

    GetTimer_us(RESET);
    while(!UART3IsPressed())
    {
        time= GetTimer_us(NO_RESET);
        if (time > timeout)
            return 0;
    }

    GetTimer_us(RESET);
    while(p < 255)
    {
        time= GetTimer_us(NO_RESET);
        if (time > timeout)
            break;
        if(UART3IsPressed())
            message[p]= UART3GetChar();
        else
            continue;
        if(message[p] == '\0')
            break;
        p++;
    }
    message[p]= '\0';
    // empty buffer (remaining newline etc.)
    while(UART3IsPressed())
        UART3GetChar();

    return strlen(message);
}

void SendUSBMessage(char *message, unsigned int len)
{
    BYTE tosend;

    // give up if the other end isn't listening!
    if(!USBUSARTIsTxTrfReady())
        return;

    while (len)
    {
        if(len <= (int) 255)
            tosend= (BYTE) len;
        else
            tosend= (BYTE) 255;

        putUSBUSART(message, tosend);
        message += tosend;
        len -= tosend;

        // don't return until message is sent otherwise we get problems
        // with buffer being overwitten - e.g. LIST
        while (!USBUSARTIsTxTrfReady())
            CDCTxService();
    }
}

BYTE get_prompt(unsigned char *prompt)
{
    BYTE tmp;

    UserMessage("\r\n%s and hit <RETURN> to continue, or any other key to abort...", prompt);
    while(42)
        if (GetUserMessage(&tmp, 1))
        {
            UserMessage("%s", "\r\n");
            return (tmp == '\r');
        }
}

// blink USB/Comms lights to show current status:
//
// USB blinking - powered by USB, comms over USB possible
// USB solid - powered by USB, comms over USB not possible
// Comms blinking - comms currently over USB
// if Comms and USB blink together we are in API mode, otherwise CLI
// FIXME: need a similar stategy for UART
// Comms solid - comms currently over UART
void BlinkCommsStatus(void)
{

    if(Led_Count == 0)
        Led_Count = 65535;

    Led_Count--;

    if(USBSuspendControl == 1)
    {
        if(Led_Count == 0)
        {
            mLED_USB_Toggle();
            if(mGetLED_USB())
            {
                mLED_Comms_On();
            }
            else
            {
                mLED_Comms_Off();
            }
        }//end if
    }
    else
    {
        if(USBDeviceState == DETACHED_STATE)
        {
            mLED_Both_Off();
        }
        else if(USBDeviceState == ATTACHED_STATE)
        {
            mLED_Both_On();
        }
        else if(USBDeviceState == POWERED_STATE)
        {
            mLED_Only_USB_On();
        }
        else if(USBDeviceState == DEFAULT_STATE)
        {
            mLED_Only_Comms_On();
        }
        else if(USBDeviceState == ADDRESS_STATE)
        {
            if(Led_Count == 0)
            {
                mLED_USB_Toggle();
                mLED_Comms_Off();
            }//end if
        }
        else if(USBDeviceState == CONFIGURED_STATE)
        {
            if(Led_Count == 0)
            {
                mLED_USB_Toggle();
                if(mGetLED_USB() ^ Interface)
                {
                    mLED_Comms_Off();
                }
                else
                {
                    mLED_Comms_On();
                }
            }//end if
        }//end if(...)
    }//end if(UCONbits.SUSPND...)

    // are we talking over UART?
    if (CommsChannel == COMMS_UART)
        mLED_Comms_On();

}

// check if user is trying to interrupt
BOOL get_user_abort(void)
{
    if (GetUserMessage(Comms_In_Buffer, 64))
        return TRUE;

    return FALSE;
}

// send end of data
void eod(void)
{
    if(Interface == INTERFACE_API)
        UserMessage("%s", "*\r\n");
    else
        UserMessage("%s", "\r\n");
}
