Register.h

Go to the documentation of this file.

#ifndef TEMU_REGISTER_H
#define TEMU_REGISTER_H
#include <stdint.h>
#include "temu-c/Support/Attributes.h"
#include "temu-c/Support/Objsys.h"
#include "temu-c/Memory/Memory.h"

/*
 * EXPERIMENTAL API
 * API Changes:
 *   2018-06-11: Remove wr and rd arguments from temu_addField
 *               Replace the separate flag params with a flag bit field.
 */

// Registers are normal properties suitable for device registers (must
// be of an integer type), but have addtitional meta-data attached to
// them. Primarily you can associate fields with a register, a
// register field may even have individual accessors which can be
// invoked to set single bits.

#ifdef __cplusplus
extern "C" {
#endif

typedef struct temu_RegisterBank temu_RegisterBank;
typedef struct temu_Register temu_Register;
typedef struct temu_Field temu_Field;

TEMU_API temu_RegisterBank *
temu_addRegisterBank(temu_Class *C, const char *Name,
                     temu_MemAccessIface *MemAccessIface);

TEMU_API const char *temu_getRegisterBankName(temu_RegisterBank *Bank);

TEMU_API temu_Register *
temu_addRegister(temu_RegisterBank *Bank, const char *Name, int Offset,
                 temu_Type Typ, int Count, temu_PropWriter Wr,
                 temu_PropReader Rd, const char *Doc,
                 // Offset of register from device mapping (or bank mapping)
                 // in memory space
                 uint32_t DeviceOffset, uint32_t Stride);

#define TEMU_FIELD_WR (1 << 0)
#define TEMU_FIELD_WARM_RESET (1 << 1)

TEMU_API void temu_addField(temu_Register *R, const char *Name, uint64_t Mask,
                            uint64_t ColdReset, uint64_t WarmReset,
                            uint64_t Flags, const char *Doc);

TEMU_API temu_RegisterBank *temu_getRegisterBank(temu_Class *C,
                                                 const char *Name);

TEMU_API int temu_getRegisterBanks(temu_Class *C, unsigned Idx, unsigned Length,
                                   temu_RegisterBank **Banks);

TEMU_API temu_Register *temu_getRegister(temu_RegisterBank *Bank,
                                         const char *Name);

TEMU_API int temu_getRegisters(temu_RegisterBank *Bank, unsigned Idx,
                               unsigned Length, temu_Register **Regs);

TEMU_API const char *temu_getRegisterName(temu_Register *R);

TEMU_API const char *temu_getRegisterDocs(temu_Register *R);

TEMU_API temu_Field *temu_getField(temu_Register *R, const char *Name);

TEMU_API int temu_getFields(temu_Register *R, unsigned Idx, unsigned Length,
                            temu_Field **Fields);

TEMU_API const char *temu_getFieldName(temu_Field *R);

TEMU_API const char *temu_getFieldDocs(temu_Field *R);

TEMU_API uint64_t temu_getFieldMask(temu_Field *Field);

TEMU_API uint64_t temu_getFieldValue(void *Obj, const char *RegName,
                                     const char *FieldName);

TEMU_API int temu_setFieldValue(void *Obj, const char *RegName,
                                const char *FieldName, uint64_t Value);

TEMU_API int temu_writeFieldValue(void *Obj, const char *RegName,
                                  const char *FieldName, uint64_t Value);

TEMU_API uint64_t temu_getRegisterColdResetValue(temu_Register *Reg);

TEMU_API uint64_t temu_getRegisterWarmResetValue(temu_Register *Reg);

TEMU_API uint64_t temu_getRegisterWriteMask(temu_Register *Reg);

TEMU_API uint64_t temu_getRegisterReadMask(temu_Register *Reg);

#ifdef __cplusplus
} // extern c
#endif

#endif /* ! TEMU_REGISTER_H */