user_algorithm_interface.h

Go to the documentation of this file.

#ifndef USER_ALGORITHM_INTERFACE_H
#define USER_ALGORITHM_INTERFACE_H

#include <systemc.h>
#include "utils.h"

using namespace std;

enum User_algorithm_action {CURRENT_MODULE_READY, NEXT_MODULE_READY, WAIT_FOR_NEXT_MODULE, WAIT_FOR_CURRENT_MODULE};

template<int Ni, int No>
class User_algorithm_interface : public sc_interface {
        
public:

        //
        // ======== DATA ========
        //

        virtual int* get_data_in_ptr(int socket) = 0;

        virtual int* get_data_in_ptr(string name) = 0;

        virtual int* get_data_out_ptr(int socket) = 0;

        virtual int* get_data_out_ptr(string name) = 0;

        virtual sc_dt::uint64 get_address_in(int socket) const = 0;

        virtual sc_dt::uint64 get_address_in(string name) const = 0;

        virtual void set_address_out(int socket, sc_dt::uint64 value) = 0;

        virtual void set_address_out(string name, sc_dt::uint64 value) = 0;

        virtual int get_data_in_length(int socket) const = 0;

        virtual int get_data_in_length(string name) const = 0;

        virtual int get_data_out_length(int socket) const = 0;

        virtual int get_data_out_length(string name) const = 0;

        virtual sc_time get_WCET(void) const = 0;

        virtual sc_time get_BCET(void) const = 0;

        virtual int get_input_socket_id(string name) const = 0;

        virtual int get_output_socket_id(string name) const = 0;


        //
        // ======== Control ========
        //

        virtual void end_of_algorithm(void) = 0;

        virtual void preemption_point(void) = 0;

        virtual void b_execution_requested(void) = 0;

        virtual void compute(sc_time duration) = 0;


        //
        // ======== Trace ========
        //

        virtual void set_algorithm_running(void) = 0;

        virtual void set_algorithm_idle(void) = 0;

        virtual void set_algorithm_waiting(void) = 0;


        //
        // ======== User algorithm management ========
        //

        virtual const sc_event& update_user_algorithm(void) const = 0;

        virtual void wait_for_update_user_algorithm(void) = 0;

        virtual bool& kill_user_algorithm(void) = 0;


        //
        // ======== Data received ========
        //

        virtual void b_data_received(string name) = 0;

        virtual void b_data_received(int id) = 0;

        virtual void b_all_data_received(void) = 0;

        virtual bool nb_data_received(string name) = 0;

        virtual bool nb_data_received(int id) = 0;

        virtual bool nb_all_data_received(void) = 0;


        //
        // ======== Send data ========
        //

        virtual void nb_send_data(string name) = 0;

        virtual void nb_send_data(int id) = 0;

        virtual void nb_send_all_data(void) = 0;

        virtual void b_send_data(string name) = 0;

        virtual void b_send_data(int id) = 0;

        virtual void b_send_all_data(void) = 0;


        //
        // ======== Data sent ========
        //

        virtual void b_data_sent(int id) = 0;

        virtual void b_data_sent(string name) = 0;

        virtual void b_all_data_sent(void) = 0;

        virtual bool nb_data_sent(int id) = 0;
        
        virtual bool nb_data_sent(string name) = 0;

        virtual bool nb_all_data_sent(void) = 0;

        virtual void start_new_transaction_sequence(int id) = 0;

        virtual void start_new_transaction_sequence(string name) = 0;

        virtual void start_new_transaction_sequence(void) = 0;
        


        //
        // ======== Transient channels ========
        //

        virtual bool is_channel_transient(string name) = 0;

        virtual bool is_channel_transient(int id) = 0;


        //
        // ======== Algorithm execution mode ========
        //

        virtual string get_algorithm_execution_mode(void) = 0;

        virtual bool is_algorithm_execution_mode(string mode) = 0;


        //
        // ======== Input socket management ========
        //

        virtual void release_input_socket(int socketID) = 0;

        virtual void release_input_socket(string connectionName) = 0;

        virtual void release_all_input_sockets(void) = 0;


        //
        // ======== Misc ========
        //

        virtual const char* get_name(void) const = 0;

        virtual int get_nb_preemption_points(void) = 0;

        virtual void wait_until_next_period(void) = 0;

        virtual ofstream& get_logfile(void) = 0;

};

#endif