Moved EDBG protocol code to more appropriate directory.

Updated necessary namespaces. Other bits of tidying.
2023-11-17 22:20:39 +00:00
parent 3ec365290e
commit 55d3fe76e0
89 changed files with 223 additions and 223 deletions
--- a/src/DebugToolDrivers/Microchip/Protocols/EDBG/AVR/EdbgAvrIspInterface.hpp
+++ b/src/DebugToolDrivers/Microchip/Protocols/EDBG/AVR/EdbgAvrIspInterface.hpp
@@ -0,0 +1,104 @@
+#pragma once
+
+#include <cstdint>
+#include <chrono>
+#include <thread>
+#include <cassert>
+
+#include "src/DebugToolDrivers/TargetInterfaces/Microchip/AVR/AvrIspInterface.hpp"
+#include "src/DebugToolDrivers/Microchip/Protocols/EDBG/EdbgInterface.hpp"
+
+namespace DebugToolDrivers::Microchip::Protocols::Edbg::Avr
+{
+    /**
+     * The EdbgAvrIspInterface implements the AVRISP EDBG/CMSIS-DAP protocol, as an AvrIspInterface.
+     *
+     * See the "AVR ISP Protocol" section in the DS50002630A document by Microchip, for more information on the
+     * protocol.
+     *
+     * This implementation should work with any Microchip EDBG-based CMSIS-DAP debug tool with ISP support (such as
+     * the Atmel-ICE, Power Debugger, the MPLAB SNAP debugger (in "AVR mode"), etc).
+     */
+    class EdbgAvrIspInterface: public TargetInterfaces::Microchip::Avr::AvrIspInterface
+    {
+    public:
+        explicit EdbgAvrIspInterface(EdbgInterface* edbgInterface);
+
+        /**
+         * The EdbgAvrIspInterface doesn't actually require any config from the user, at this point in time. So this
+         * function does nothing, for now.
+         *
+         * @param targetConfig
+         */
+        void configure(const TargetConfig& targetConfig) override {};
+
+        /**
+         * Accepts the target's ISP parameters. These should be extracted from the target's TDF.
+         *
+         * @param ispParameters
+         */
+        void setIspParameters(const Targets::Microchip::Avr::IspParameters& ispParameters) override;
+
+        /**
+         * Initialises the ISP interface by enabling "programming mode" on the debug tool. This will activate the
+         * physical (SPI) interface between the debug tool and AVR target.
+         */
+        void activate() override;
+
+        /**
+         * Disables "programming mode" on the debug tool, which subsequently deactivates the SPI interface between the
+         * debug tool and AVR target.
+         */
+        void deactivate() override;
+
+        /**
+         * Obtains the AVR signature from the connected AVR.
+         *
+         * @return
+         */
+        Targets::Microchip::Avr::TargetSignature getDeviceId() override;
+
+        /**
+         * Reads a particular fuse byte from the AVR target.
+         *
+         * @param fuseType
+         * @return
+         */
+        Targets::Microchip::Avr::Fuse readFuse(Targets::Microchip::Avr::FuseType fuseType) override;
+
+        /**
+         * Reads the lock bit byte from the AVR target.
+         *
+         * @return
+         */
+        unsigned char readLockBitByte() override;
+
+        /**
+         * Programs a particular fuse on the AVR target.
+         *
+         * @param fuse
+         */
+        void programFuse(Targets::Microchip::Avr::Fuse fuse) override;
+
+    private:
+        /**
+         * The AVRISP protocol is a sub-protocol of the EDBG AVR protocol, which is served via CMSIS-DAP vendor
+         * commands.
+         *
+         * Every EDBG based debug tool that utilises this implementation must provide access to its EDBG interface.
+         */
+        EdbgInterface* edbgInterface;
+
+        Targets::Microchip::Avr::IspParameters ispParameters;
+
+        /**
+         * The EDBG AVRISP protocol only allows us to read a single signature byte at a time.
+         * This function will read a single signature byte. See implementation of EdbgAvrIspInterface::getDeviceId()
+         * for more.
+         *
+         * @param signatureByteAddress
+         * @return
+         */
+        [[nodiscard]] unsigned char readSignatureByte(std::uint8_t signatureByteAddress);
+    };
+}