clock_domain.h

Go to the documentation of this file.

#ifndef NEXUS_COMPONENTS_CLOCK_DOMAIN_H
#define NEXUS_COMPONENTS_CLOCK_DOMAIN_H
#include "nexus/core/status.h"
#ifdef __cplusplus
extern "C" {
#endif
typedef struct nx_clock_domain nx_clock_domain_t;
typedef struct nx_clock_lease {
    nx_clock_domain_t* owner;
    struct nx_clock_lease* next;
    uint64_t epoch;
} nx_clock_lease_t;

typedef struct {
    nx_clock_domain_t* domain;
    uint64_t epoch;
} nx_clock_barrier_t;

typedef enum {
    NX_CLOCK_SHALLOW_SLEEP = 0,
    NX_CLOCK_DEEP_STOP,
    NX_CLOCK_DYNAMIC_RUN
} nx_clock_power_mode_t;

nx_result_t nx_clock_domain_acquire(nx_clock_domain_t* domain,
                                    nx_clock_lease_t* lease);
nx_result_t nx_clock_domain_release(nx_clock_domain_t* domain,
                                    nx_clock_lease_t* lease);
nx_result_t nx_clock_domain_close(nx_clock_domain_t* domain,
                                  nx_clock_barrier_t* control);
nx_result_t nx_clock_domain_quiescent(nx_clock_barrier_t control);
nx_result_t nx_clock_domain_reopen(nx_clock_barrier_t control);
#ifdef __cplusplus
}
#endif
#endif /* NEXUS_COMPONENTS_CLOCK_DOMAIN_H */