AntikernelLabsGPIO.h

Go to the documentation of this file.

/***********************************************************************************************************************
*                                                                                                                      *
* libscopehal                                                                                                          *
*                                                                                                                      *
* Copyright (c) 2012-2026 Andrew D. Zonenberg and contributors                                                         *
* All rights reserved.                                                                                                 *
*                                                                                                                      *
* Redistribution and use in source and binary forms, with or without modification, are permitted provided that the     *
* following conditions are met:                                                                                        *
*                                                                                                                      *
*    * Redistributions of source code must retain the above copyright notice, this list of conditions, and the         *
*      following disclaimer.                                                                                           *
*                                                                                                                      *
*    * 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.                *
*                                                                                                                      *
*    * Neither the name of the author nor the names of any contributors may be used to endorse or promote products     *
*      derived from this software without specific prior written permission.                                           *
*                                                                                                                      *
* THIS SOFTWARE IS PROVIDED BY THE AUTHORS "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 AUTHORS BE HELD 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 AntikernelLabsGPIO_h
#define AntikernelLabsGPIO_h
 
class AntikernelLabsGPIO
    : public virtual SCPIMiscInstrument
{
public:
    AntikernelLabsGPIO(SCPITransport* transport);
    virtual ~AntikernelLabsGPIO();
 
    //Device information
    virtual uint32_t GetInstrumentTypes() const override;
    virtual uint32_t GetInstrumentTypesForChannel(size_t i) const override;
 
    //Acquisition
    virtual bool AcquireData() override;
 
protected:
 
    void DoPreLoadConfiguration(int version, const YAML::Node& node, IDTable& idmap, ConfigWarningList& list);
 
    bool m_cachedConfigValid;
    uint32_t m_cachedTris;
    uint32_t m_cachedOut;
 
public:
 
    //This is intentionally not virtual since it's a static method used by enumeration
    //cppcheck-suppress duplInheritedMember
    static std::vector<SCPIInstrumentModel> GetDriverSupportedModels()
    {
        return
        {
            {"gpio", {{ SCPITransportType::TRANSPORT_LAN, "localhost:5025" }}}
        };
    }
 
    static std::string GetDriverNameInternal();
    MISC_INITPROC(AntikernelLabsGPIO);
};
 
#endif