DESERT_Addons/uwmphy_modem/uwmdriver.h

Go to the documentation of this file.

//
// Copyright (c) 2017 Regents of the SIGNET lab, University of Padova.
// 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. Neither the name of the University of Padova (SIGNET lab) nor the
//    names of its 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.
 
#ifndef UWMDRIVER_H
#define UWMDRIVER_H
 
#include "uwmconnector.h"
#include "uwminterpreter.h"
 
#include <stdlib.h>
#include <iostream>
#include <stdio.h>
#include <fstream>
#include <string.h>
#include <cstring>
#include <sstream>
#include <sys/types.h>
#include <sys/stat.h>
#include <fcntl.h>
#include <unistd.h>
#include <cmath>
 
#define MAX_LOG_LEVEL 2
 
enum MODEM_STATES {
    MODEM_IDLE = 0,
    MODEM_TX,
    MODEM_RX,
    MODEM_IDLE_RX,
    MODEM_CFG,
    MODEM_TX_PAUSED,
    MODEM_TX_RX,
    MODEM_RESET,
    MODEM_NOISE,
    MODEM_MULTIPATH,
    MODEM_CHANGE_POWER_LEVEL,
    MODEM_QUIT
};
 
enum LOG_LEVEL { LOG_LEVEL_ERROR = 0, LOG_LEVEL_INFO, LOG_LEVEL_DEBUG };
 
typedef enum LOG_LEVEL log_level_t;
 
typedef enum MODEM_STATES modem_state_t;
 
 
 
// Forward declaration(s)
class UWMPhy_modem;
class UWMcodec;
 
class UWMdriver
{
public:
    UWMdriver(UWMPhy_modem *);
 
    ~UWMdriver();
 
    virtual void modemSetID() = 0;
 
    virtual void start() = 0;
 
    virtual void stop() = 0;
 
    virtual void modemTx() = 0;
    virtual modem_state_t updateStatus() = 0;
 
    inline void
    setID(int ID_)
    {
        ID = ID_;
    }
 
    void resetModemStatus();
 
    void updateTx(int, std::string);
 
    void updateRx(int, int, std::string);
 
    int
    getID()
    {
        return ID;
    }
 
    modem_state_t
    getStatus()
    {
        return status;
    }
 
    std::string
    getRxPayload()
    {
        return payload_rx;
    }
 
    int
    getSrc()
    {
        return src;
    }
 
    int
    getDstPktRx()
    {
        return dstPktRx;
    }
 
    inline log_level_t
    getDebug()
    {
        return (log_level_t) debug_;
    }
 
    inline void
    setModemID(bool set)
    {
        SetModemID = set;
    }
    inline bool
    getModemID()
    {
        return SetModemID;
    }
 
    inline void
    setResetModemQueue(bool reset_m_queue)
    {
        ResetModemQueue = reset_m_queue;
    }
 
    inline bool
    getResetModemQueue()
    {
        return ResetModemQueue;
    }
    log_level_t getLogLevel();
 
    std::string getLogFile();
 
    void printOnLog(log_level_t log_level, std::string module, std::string message);
 
protected:
    UWMPhy_modem *pmModem; 
    UWMinterpreter
            *pmInterpreter; 
    UWMconnector *pmConnector; 
    int ID; 
    modem_state_t status; 
    // TX VARIABLES (variables for the next packet to be transmitted)
    std::string payload_tx; 
    int dest; 
    // RX VARIABLES (variables reffering to the last received packet)
    std::string payload_rx; 
    int src; 
    int dstPktRx; 
    bool SetModemID; 
    int debug_; 
    std::ofstream outLog; 
    bool ResetModemQueue;
    void setConnections(UWMinterpreter *, UWMconnector *);
 
    virtual void modemTxManager() = 0;
};
#endif /* UWMDRIVER_H */