HardwareResource.h

Go to the documentation of this file.

#ifndef HARDWARE_RESOURCE_H
#define HARDWARE_RESOURCE_H
 
#include "Debug.h"


class HardwareResource{
  public: 

  enum Type{
    UART, 
    SPI,  
    I2C,  
    PWM,   
    CAN    
  }; 

  virtual Type getType()=0;

  virtual bool reset(){
    DEBUG_PRINTLN("[HardwareResource] Resetting hardware resource of type " + String((int)getType()));
    usages = 0;
    return true;
  }

  bool requestUsage(){
    if(usages >= getMaxUsages() && getMaxUsages() != 0){
      ERROR_PRINTLN("[HardwareResource] Hardware resource of type " + String((int)getType()) + " already used by maximum number of modules (" + String(getMaxUsages()) + ").");
      return false;
    }
    usages++;
    DEBUG_PRINTLN("[HardwareResource] Hardware resource of type " + String((int)getType()) + " usage requested. Current usages: " + String(usages) + "/" + String(getMaxUsages()));
    return true;
  }

  uint8_t getUsages(){return usages;}

  bool isUsed(){ return usages > 0; }

  virtual uint8_t getRemainingUsages(){ return getMaxUsages() - usages; }
 
  private:
    
    
  protected: 
    uint8_t usages=0;

    HardwareResource() = default;

    virtual uint8_t getMaxUsages(){ return 1; }
 
};
 
#endif