Request.h

Go to the documentation of this file.

/****
 * Sming Framework Project - Open Source framework for high efficiency native ESP8266 development.
 * Created 2015 by Skurydin Alexey
 * http://github.com/anakod/Sming
 * All files of the Sming Core are provided under the LGPL v3 license.
 *
 * Request.h
 *
 * @author: 11 December 2018 - mikee47 <mike@sillyhouse.net>
 *
 * Definitions for an SPI Request Packet containing data and settings for a transfer.
 * A single transfer may use 1 or more transactions.
 *
 */

#pragma once

#include "Data.h"

namespace HSPI
{
class Device;
struct Request;

typedef void (*Callback)(Request& request);

struct Request {
    Device* device{nullptr};       
    Request* next{nullptr};        
    uint16_t cmd{0};               
    uint8_t cmdLen{0};             
    uint8_t maxTransactionSize{0}; 
    uint8_t async : 1;             
    uint8_t task : 1;              
    volatile uint8_t busy : 1;   
    uint32_t addr{0};              
    uint8_t addrLen{0};            
    uint8_t dummyLen{0};           
    Data out;                      
    Data in;                       
    Callback callback{nullptr}; 
    void* param{nullptr};          

    Request() : async(false), task(false), busy(false)
    {
    }

    void prepare()
    {
        while(busy) {
            ;
        }
        busy = false;
        task = false;
    }

    void setCommand(uint16_t command, uint8_t bitCount)
    {
        cmd = command;
        cmdLen = bitCount;
    }

    void setCommand8(uint8_t command)
    {
        setCommand(command, 8);
    }

    void setCommand16(uint16_t command)
    {
        setCommand(command, 16);
    }

    void setAddress(uint32_t address, uint8_t bitCount)
    {
        addr = address;
        addrLen = bitCount;
    }

    void setAddress24(uint32_t address)
    {
        setAddress(address, 24);
    }

    void setAsync(Callback callback = nullptr, void* param = nullptr)
    {
        async = true;
        this->callback = callback;
        this->param = param;
    }
};

} // namespace HSPI