rndis_task.c

Go to the documentation of this file.

/* This file has been prepared for Doxygen automatic documentation generation.*/
/*! \file rndis_task.c *********************************************************
 *
 * \brief
 *      Manages the RNDIS Dataclass for the USB Device
 *
 * \addtogroup usbstick
 *
 * \author
 *        Colin O'Flynn <coflynn@newae.com>
 *
 ******************************************************************************/
/* Copyright (c) 2008  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 following disclaimer.
   * 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.
   * Neither the name of the copyright holders nor the names of
     contributors may be used to endorse or promote products derived
     from this software without specific prior written permission.

  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS 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.
*/
/**
 \addtogroup RNDIS
 @{
 */

//_____  I N C L U D E S ___________________________________________________


#include "contiki.h"
#include "usb_drv.h"
#include "usb_descriptors.h"
#include "usb_specific_request.h"
#include "rndis/rndis_task.h"
#include "rndis/rndis_protocol.h"
#if RF230BB
#include "rf230bb.h"
#endif
#include "uip.h"
#include "sicslow_ethernet.h"
#include <stdio.h>

#include <avr/pgmspace.h>
#include <util/delay.h>
#include "watchdog.h"

#include "rndis/cdc_ecm.h"
#include "rndis/cdc_eem.h"

#define BUF ((struct uip_eth_hdr *)&uip_buf[0])
#define PRINTF printf
#define PRINTF_P printf_P

//_____ M A C R O S ________________________________________________________





//_____ D E F I N I T I O N S ______________________________________________


#define IAD_TIMEOUT_DETACH 400
#define IAD_TIMEOUT_ATTACH 800

#define RNDIS_TIMEOUT_DETACH 900
#define RNDIS_TIMEOUT_ATTACH 1000

#define PBUF ((rndis_data_packet_t *) usb_eth_data_buffer)

//! Temp data buffer when adding RNDIS headers
uint8_t usb_eth_data_buffer[64];

uint64_t usb_ethernet_addr = 0x010000000002ULL;

//_____ D E C L A R A T I O N S ____________________________________________


//! Timers for LEDs
uint8_t led1_timer, led2_timer;

uint8_t usb_eth_is_active = 1;


uint8_t usb_eth_packet_is_available() {
        Usb_select_endpoint(RX_EP);
        return Is_usb_read_enabled();
}


uint8_t usb_eth_ready_for_next_packet() {
#ifdef USB_ETH_HOOK_IS_READY_FOR_INBOUND_PACKET
        return USB_ETH_HOOK_IS_READY_FOR_INBOUND_PACKET();
#else
        return 1;
#endif

        return 1;
}

void rxtx_led_update(void)
{
        // turn off LED's if necessary
        if (led1_timer) {
                led1_timer--;
                if(led1_timer&(1<<2))
                        Led1_on();
                else
                        Led1_off();
        }
        else
                Led1_off();

        if (led2_timer) {
                led2_timer--;
                if(led2_timer&(1<<2))
                        Led2_on();
                else
                        Led2_off();
        }
        else
                Led2_off();
}

/**
    @brief This will enable the RX_START LED for a period
*/
void rx_start_led(void)
{
        led1_timer|=(1<<3);
        if(((led1_timer-1)&(1<<2)))
                Led1_on();
}

/**
    @brief This will enable the TRX_END LED for a period
*/
void tx_end_led(void)
{
        led2_timer|=(1<<3);
        if(((led2_timer-1)&(1<<2)))
                Led1_on();
}

#if USB_ETH_CONF_MASS_STORAGE_FALLBACK
static void
usb_eth_setup_timeout_fallback_check() {
        extern uint8_t fingerPresent;
                /* Device is Enumerated but RNDIS not loading. We might
                   have a system that does not support IAD (winXP). If so
                   count the timeout then switch to just network interface. */
        static uint16_t iad_fail_timeout, rndis_fail_timeout;   
        if (usb_mode == rndis_debug) {
                //If we have timed out, detach
                if (iad_fail_timeout == IAD_TIMEOUT_DETACH) {
                
                        //Failed - BUT we are using "reverse logic", hence we force device
                        //into this mode. This is used to allow Windows Vista have time to
                        //install the drivers
                        if (fingerPresent && (rndis_state != rndis_data_initialized) && Is_device_enumerated() ) {
                                iad_fail_timeout = 0;
                        } else {
                                        stdout = NULL;
                                        Usb_detach();
                                        doInit = 1; //Also mark system as needing intilizing
                        }
                        
                //Then wait a few before re-attaching
                } else if (iad_fail_timeout == IAD_TIMEOUT_ATTACH) {
                
                        if (fingerPresent) {
                                usb_mode = mass_storage;
                        } else {
                                usb_mode = rndis_only;
                        }
                        Usb_attach();
                }

                //Increment timeout when device is not initializing, OR we have already detached,
                //OR the user had their finger on the device, indicating a reverse of logic
                if ( ( (rndis_state != rndis_data_initialized) && Is_device_enumerated() ) ||
                  (iad_fail_timeout > IAD_TIMEOUT_DETACH) || 
                   (fingerPresent) ) {
                        iad_fail_timeout++;
                } else {        
                iad_fail_timeout = 0;
                }
        } //usb_mode == rndis_debug


         /* Device is Enumerated but RNDIS STIL not loading. We just
                have RNDIS interface, so obviously no drivers on target.
                Just go ahead and mount ourselves as mass storage... */
        if (usb_mode == rndis_only) {
                //If we have timed out, detach
                if (rndis_fail_timeout == RNDIS_TIMEOUT_DETACH) {
                        Usb_detach();
                //Then wait a few before re-attaching
                } else if (rndis_fail_timeout == RNDIS_TIMEOUT_ATTACH) {
                        usb_mode = mass_storage;
                        Usb_attach();
                }

                //Increment timeout when device is not initializing, OR we are already
                //counting to detach
                if ( ( (rndis_state != rndis_data_initialized)) ||
                  (rndis_fail_timeout > RNDIS_TIMEOUT_DETACH) ) {
                        rndis_fail_timeout++;
                } else {        
                rndis_fail_timeout = 0;
                }
        }//usb_mode == rnids_only
}
#endif

PROCESS(usb_eth_process, "USB Ethernet process");

/**
 * \brief RNDIS Process
 *
 *   This is the link between USB and the "good stuff". In this routine data
 *   is received and processed by RNDIS, CDC-ECM, or CDC-EEM
 */
PROCESS_THREAD(usb_eth_process, ev, data_proc)
{
        static struct etimer et;

        PROCESS_BEGIN();

        while(1) {
                rxtx_led_update();

#if USB_ETH_CONF_MASS_STORAGE_FALLBACK
                usb_eth_setup_timeout_fallback_check();
#endif
                
                switch(usb_configuration_nb) {
                        case USB_CONFIG_RNDIS_DEBUG:
                        case USB_CONFIG_RNDIS:
                                if(Is_device_enumerated()) {
                                        if(rndis_process()) {
                                                etimer_set(&et, CLOCK_SECOND/80);
                                        } else {
                                                Led0_toggle();
                                                etimer_set(&et, CLOCK_SECOND/8);
                                        }
                                }
                                break;
                        case USB_CONFIG_EEM:
                                if(Is_device_enumerated())
                                        cdc_eem_process();
                                etimer_set(&et, CLOCK_SECOND/80);
                                break;
                        case USB_CONFIG_ECM:
                        case USB_CONFIG_ECM_DEBUG:
                                if(Is_device_enumerated()) {
                                        if(cdc_ecm_process()) {
                                                etimer_set(&et, CLOCK_SECOND/80);
                                        } else {
                                                Led0_toggle();
                                                etimer_set(&et, CLOCK_SECOND/8);
                                        }
                                }
                                break;
                        default:
                                Led0_toggle();
                                etimer_set(&et, CLOCK_SECOND/4);
                                break;
                }


                PROCESS_WAIT_EVENT_UNTIL(etimer_expired(&et)||(usb_eth_packet_is_available()&&usb_eth_ready_for_next_packet()));
        } // while(1)

        PROCESS_END();
}

/**
 \brief Sends a single ethernet frame over USB using appropriate low-level protocol (EEM or RNDIS)
 \param senddata Data to send
 \param sendlen Length of data to send
 \param led Should the LED be light up for this frame?
 */
uint8_t usb_eth_send(uint8_t * senddata, uint16_t sendlen, uint8_t led)
{
        uint8_t ret = 0;
        
        if(!usb_eth_is_active) {
                USB_ETH_HOOK_TX_ERROR("Inactive");
                goto bail;
        }

        //Check device is set up
        if (Is_device_enumerated() == 0) {
                USB_ETH_HOOK_TX_ERROR("Device not enumerated");
                goto bail;
        }

        switch(usb_configuration_nb) {
                case USB_CONFIG_RNDIS_DEBUG:
                case USB_CONFIG_RNDIS:
                        ret = rndis_send(senddata, sendlen, led);
                        break;
                case USB_CONFIG_EEM:
                        ret = eem_send(senddata, sendlen, led);
                        break;
                case USB_CONFIG_ECM:
                case USB_CONFIG_ECM_DEBUG:
                        ret = ecm_send(senddata, sendlen, led);
                        break;
        }

bail:

        if(!ret) // Hit the watchdog if we have a successful send.
                watchdog_periodic();

        return ret;
}

uint8_t
usb_eth_set_active(uint8_t active) {
        if(usb_eth_is_active!=active) { 
                switch(usb_configuration_nb) {
                        case USB_CONFIG_RNDIS_DEBUG:
                        case USB_CONFIG_RNDIS:
                                usb_eth_is_active = active;
                                rndis_send_interrupt();
                                break;
                        case USB_CONFIG_EEM:
                                break;
                        case USB_CONFIG_ECM:
                        case USB_CONFIG_ECM_DEBUG:
                                cdc_ecm_set_active(active);
                                usb_eth_is_active = active;
                                break;
                }
        }
        return 0;
}

void
usb_eth_get_mac_address(uint8_t dest[6]) {
        memcpy(dest,&usb_ethernet_addr,6);
}

void
usb_eth_set_mac_address(const uint8_t src[6]) {
        memcpy(&usb_ethernet_addr,src,6);
}

/** @}  */