pin_event.h

Go to the documentation of this file.

// MIT License
//
// Copyright (c) 2019 Ruhr University Bochum, Chair for Embedded Security. All Rights reserved.
// Copyright (c) 2019 Marc Fyrbiak, Sebastian Wallat, Max Hoffmann ("ORIGINAL AUTHORS"). All rights reserved.
// Copyright (c) 2021 Max Planck Institute for Security and Privacy. All Rights reserved.
// Copyright (c) 2021 Jörn Langheinrich, Julian Speith, Nils Albartus, René Walendy, Simon Klix ("ORIGINAL AUTHORS"). All Rights reserved.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in all
// copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.
 
#pragma once
 
#include "hal_core/utilities/enums.h"
#include "hal_core/defines.h"
#include <unordered_map>
#include <vector>
 
namespace hal
{
    enum class PinEvent
    {
        unknown,
        GroupCreate,                    
        GroupRename,                    
        GroupTypeChange,                
        GroupDirChange,                 
        GroupReorder,                   
        PinCreate,                      
        PinAssignToGroup,               
        PinRename,                      
        PinTypeChange,                  
        PinDirChange,                   
        PinReorder,                     
        PinDelete,                      
        GroupDelete,                    
        PinsReload                      
    };
 
    static_assert((u32)PinEvent::PinsReload <= 0xF, "PinEvent no longer fits into the 4 bit of associated data");
 
    template<>
    std::map<PinEvent, std::string> EnumStrings<PinEvent>::data;
 
    class Module;
 
    class PinChangedEvent
    {
        friend bool pin_event_order(const PinChangedEvent& a, const PinChangedEvent& b);
        friend class PinChangedEventScope;
        friend class PinChangedBulkScope;
 
        class EventStack : public std::vector<PinChangedEvent>
        {
        public:
            int m_count;
 
            bool m_sticky;
 
            EventStack() : m_count(0), m_sticky(false) {;}
 
            void send_events(Module* m);
        };
 
        static std::unordered_map<Module*,EventStack*> s_event_stack;
        static u64 s_order;
        static int s_bulk_depth;
 
        Module* m_module;
        PinEvent m_event;
        u32 m_id;
        u64 m_order;
 
    public:
        PinChangedEvent(Module* m, PinEvent pev, u32 id);
 
        Module* get_module() const;
 
        u32 associated_data();
 
        void send();
 
        static void discard(Module* m);
    };
 
    class PinChangedEventScope
    {
        Module* m_module;
    public:
 
        PinChangedEventScope(Module* m);
 
        ~PinChangedEventScope();
 
        void send_events();
    };
 
    class PinChangedBulkScope
    {
    public:
        PinChangedBulkScope();
 
        ~PinChangedBulkScope();
    };
 
    bool pin_event_order(const PinChangedEvent& a, const PinChangedEvent& b);
}