Ubertooth Zero solderpad

ubertooth-zero / firmware / bootloader / dfu.cpp

6.7 KB · raw

/*
 * Copyright 2010, 2011 Michael Ossmann
 *
 * This file is part of Project Ubertooth.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2, or (at your option)
 * any later version.
 *
 * 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
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; see the file COPYING.  If not, write to
 * the Free Software Foundation, Inc., 51 Franklin Street,
 * Boston, MA 02110-1301, USA.
 */

#include "dfu.h"

#include <string.h>

struct memory_policy {
    static bool write_permitted(const uint32_t flash_address) {
        // Protect flash region containing bootloader.
        return (flash_address >= 0x4000);
    }
};

DFU::DFU(Flash& flash) :
    flash(flash),
    status(OK),
    state(DFUIDLE),
    virginity(true) {
}

bool DFU::request_handler(TSetupPacket *pSetup, uint32_t *piLen, uint8_t **ppbData) {
    uint8_t* pbData = *ppbData;
    
    switch( pSetup->bRequest ) {
    case DETACH:
        return request_detach(pSetup, piLen, pbData);
        
    case DNLOAD:
        return request_dnload(pSetup, piLen, pbData);
        
    case UPLOAD:
        return request_upload(pSetup, piLen, pbData);
        
    case GETSTATUS:
        return request_getstatus(pSetup, piLen, pbData);
        
    case CLRSTATUS:
        return request_clrstatus(pSetup, piLen, pbData);
        
    case GETSTATE:
        return request_getstate(pSetup, piLen, pbData);
        
    case ABORT:
        return request_abort(pSetup, piLen, pbData);
        
    default:
        return false;
    }
}

bool DFU::in_dfu_mode() const {
    return (get_state() >= DFUIDLE);
}

bool DFU::dfu_virgin() const {
    return virginity;
}

void DFU::set_state(const State new_state) {
    state = new_state;
    virginity = false;
}

uint8_t DFU::get_state() const {
    return state;
}

void DFU::set_status(const Status new_status) {
    status = new_status;
}

uint8_t DFU::get_status() const {
    return status;
}

bool DFU::error(const Status new_status) {
    if( (get_state() != APPIDLE) &&
        (get_state() != APPDETACH) ) {
         set_state(DFUERROR);
    }
    set_status(new_status);
    return false;
}

uint8_t DFU::get_status_string_id() const {
    return 0;
}

uint32_t DFU::get_poll_timeout() const {
    return 20;  // milliseconds
}

bool DFU::request_detach(TSetupPacket *pSetup, uint32_t *piLen, uint8_t* pbData) {
    if( (pSetup->wLength == 0) && (pSetup->wValue <= detach_timeout_ms) ) {
        // TODO: Check DFU vs. APP mode, and reboot device if in DFU mode?
        set_state(APPDETACH);
        return true;
    } else {
        return error(ERRUNKNOWN);
    }
}

bool DFU::request_dnload(TSetupPacket *pSetup, uint32_t *piLen, uint8_t* pbData) {
    if( pSetup->wLength == 0 ) {
        if( get_state() != DFUDNLOAD_IDLE ) {
            return error(ERRSTALLEDPKT);
        }

        // End of transfer
        set_state(DFUMANIFEST_SYNC);
        
        return true;
    } else if( pSetup->wLength == transfer_size ) {
        if( (get_state() != DFUIDLE) && (get_state() != DFUDNLOAD_IDLE) ) {
            return error(ERRSTALLEDPKT);
        }
        
        // TODO: Improve returned error values.
        const uint32_t length = pSetup->wLength;
        const uint32_t flash_address = pSetup->wValue * transfer_size;
        const uint32_t source_address = reinterpret_cast<uint32_t>(pbData);
        if( memory_policy::write_permitted(flash_address) ) {
            if( flash.write(flash_address, source_address, length) ) {
                set_state(DFUDNLOAD_SYNC);
            } else {
                return error(ERRPROG);
            }
            return true;
        } else {
            return error(ERRWRITE);
        }
    } else {
        return error(ERRUNKNOWN);
    }
}

bool DFU::request_upload(TSetupPacket *pSetup, uint32_t *piLen, uint8_t* pbData) {
    if( pSetup->wLength == transfer_size ) {
        if( (get_state() != DFUIDLE) && (get_state() != DFUUPLOAD_IDLE) ) {
            return error(ERRSTALLEDPKT);
        }
        
        const uint32_t length = pSetup->wLength;
        const uint32_t flash_address_start = pSetup->wValue * transfer_size;
        const uint32_t flash_address_end = flash_address_start + length;
        if( flash.valid_address(flash_address_start) && flash.valid_address(flash_address_end - 1) ) {
            memcpy(pbData, reinterpret_cast<const void*>(flash_address_start), length);
            *piLen = length;
            set_state(DFUIDLE);
            return true;
        } else {
            return error(ERRADDRESS);
        }
    } else {
        return error(ERRUNKNOWN);
    }
}

bool DFU::request_getstatus(TSetupPacket *pSetup, uint32_t *piLen, uint8_t* pbData) {
    if( (pSetup->wValue == 0) && (pSetup->wLength == 6) ) {
        switch( get_state() ) {
            case DFUDNLOAD_SYNC:
                set_state(DFUDNLOAD_IDLE);
                break;
                
            case DFUMANIFEST_SYNC:
                set_state(DFUIDLE);
                break;
                
            default:
                break;
        }
        
        pbData[0] = get_status();
        pbData[1] = (get_poll_timeout() >>  0) & 0xFF;
        pbData[2] = (get_poll_timeout() >>  8) & 0xFF;
        pbData[3] = (get_poll_timeout() >> 16) & 0xFF;
        pbData[4] = get_state();
        pbData[5] = get_status_string_id();
        *piLen = 6;
        return true;
    } else {
        return false;
    }
}

bool DFU::request_clrstatus(TSetupPacket *pSetup, uint32_t *piLen, uint8_t* pbData) {
    if( (pSetup->wValue == 0) && (pSetup->wLength == 0) ) {
        if( get_state() == DFUERROR ) {
            set_status(OK);
            set_state(DFUIDLE);
            return true;
        } else {
            return error(ERRUNKNOWN);
        }
    } else {
        return error(ERRUNKNOWN);
    }
}

bool DFU::request_getstate(TSetupPacket *pSetup, uint32_t *piLen, uint8_t* pbData) {
    if( (pSetup->wValue == 0) && (pSetup->wLength == 1) ) {
        pbData[0] = get_state();
        *piLen = 1;
        return true;
    } else {
        return error(ERRUNKNOWN);
    }
}

bool DFU::request_abort(TSetupPacket *pSetup, uint32_t *piLen, uint8_t* pbData) {
    if( (pSetup->wValue == 0) && (pSetup->wLength == 0) ) {
        if( get_state() != DFUERROR ) {
            set_state(DFUIDLE);
            return true;
        } else {
            return error(ERRUNKNOWN);
        }
    } else {
        return error(ERRUNKNOWN);
    }
}