MFEPlatformData.hpp

/*
** Copyright (C) 2023 CERN
**
** This software is provided 'as-is', without any express or implied
** warranty.  In no event will the authors be held liable for any damages
** arising from the use of this software.
**
** Permission is granted to anyone to use this software for any purpose,
** including commercial applications, and to alter it and redistribute it
** freely, subject to the following restrictions:
**
** 1. The origin of this software must not be misrepresented; you must not
**    claim that you wrote the original software. If you use this software
**    in a product, an acknowledgment in the product documentation would be
**    appreciated but is not required.
** 2. Altered source versions must be plainly marked as such, and must not be
**    misrepresented as being the original software.
** 3. This notice may not be removed or altered from any source distribution.
**
** Created on: 2023-06-19T10:10:32
** Author: Sylvain Fargier <sylvain.fargier@cern.ch>
*/
 
#ifndef MFEPLATFORMDATA_HPP__
#define MFEPLATFORMDATA_HPP__
 
#if !defined(GCC_LINT)
#pragma once
#endif
 
#include "MFEPlatform.hpp"
#include "device/AxisPositionMonitor.hpp"
#include "util/edge/EdgeGrblDeviceBase.hpp"
#include "util/grbl/GrblTypes.hpp"
 
namespace smc {
namespace internal {
struct MFEPlatform::RegInfo
{
    explicit RegInfo(struct edge_reg *reg = nullptr,
                     size_t shift = 0,
                     uint32_t mask = 0xFFFFFFFF,
                     size_t size = 32) :
        reg{reg},
        shift{shift},
        mask{mask},
        size{size}
    {}
 
    struct edge_reg *reg;
    size_t shift;
    uint32_t mask;
    size_t size;
};
 
struct MFEPlatform::ResolverInfo
{
    explicit ResolverInfo(grbl::Axis grblAxis,
                          grbl::SettingId modeSettingId,
                          const units::Value &mode) :
        grblAxis{grblAxis},
        modeSettingId{modeSettingId},
        mode{mode}
    {}
 
    grbl::Axis grblAxis;
    grbl::SettingId modeSettingId;
    units::Value mode; 
    uint32_t angleReg = 0;
    uint32_t stepReg = 0;
    uint32_t diffReg = 0;
 
    AxisPositionMonitor::State monitorState = AxisPositionMonitor::State::UNKNOWN;
};
 
struct MFEPlatform::Context : public MGrblPlatform::Context
{
    explicit Context(const ccut::yml::NodeRef &ref);
 
    std::shared_ptr<edge::EdgeGrblDeviceBase> edge;
    std::map<std::string, RegInfo> registers;
 
    bool getRegInfo(const std::string &uid, RegInfo &info) const;
};
 
} // namespace internal
} // namespace smc
 
#endif