FPGA.h

/*
 * This file is part of LSST M1M3 support system package.
 *
 * Developed for the Vera C. Rubin Telescope and Site System.
 * This product includes software developed by the LSST Project
 * (https://www.lsst.org).
 * See the COPYRIGHT file at the top-level directory of this distribution
 * for details of code ownership.
 *
 * 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 3 of the License, 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.  If not, see <https://www.gnu.org/licenses/>.
 */
 
#ifndef FPGA_H_
#define FPGA_H_
 
#include <IFPGA.h>
#include <NiFpga.h>
 
namespace LSST {
namespace M1M3 {
namespace SS {

class FPGA : public IFPGA {
public:
    FPGA();
    virtual ~FPGA();
 
    void initialize() override;
    void open() override;
    void close() override;
    void finalize() override;
 
    void waitForOuterLoopClock(uint32_t timeout) override;
    void ackOuterLoopClock() override;
 
    void waitForPPS(uint32_t timeout) override;
    void ackPPS() override;
 
    void waitForModbusIRQs(uint32_t warning_timeout, uint32_t error_timeout) override;
    void ackModbusIRQs() override;
 
    void pullTelemetry() override;
    void pullHealthAndStatus() override;
 
    void writeCommandFIFO(uint16_t *data, size_t length, uint32_t timeoutInMs) override;
    void writeRequestFIFO(uint16_t *data, size_t length, uint32_t timeoutInMs) override;
    void writeTimestampFIFO(uint64_t timestamp) override;
    void readU8ResponseFIFO(uint8_t *data, size_t length, uint32_t timeoutInMs) override;
    void readU16ResponseFIFO(uint16_t *data, size_t length, uint32_t timeoutInMs) override;
 
    void waitOnIrqs(uint32_t irqs, uint32_t timeout, bool &timedout, uint32_t *triggered = NULL) override;
    void ackIrqs(uint32_t irqs) override;
 
    void writeHealthAndStatusFIFO(uint16_t request, uint16_t param = 0) override;
    void readHealthAndStatusFIFO(uint64_t *data, size_t length, uint32_t timeoutInMs = 10) override;
 
    void readRawAccelerometerFIFO(uint64_t *raw, size_t samples) override;
 
private:
    uint32_t _session;
    size_t _remaining;
    std::map<size_t, NiFpga_IrqContext> _contexes;
    NiFpga_IrqContext _outerLoopIRQContext;
    NiFpga_IrqContext _modbusIRQContext;
    NiFpga_IrqContext _ppsIRQContext;
 
    uint32_t _modbus_irqs;
};
 
} /* namespace SS */
} /* namespace M1M3 */
} /* namespace LSST */
 
#endif /* FPGA_H_ */