blob: 2e8ca41e8809a2406030b998fa095e515fca9cdb [file] [log] [blame]
Zane Shelley93b61ad2019-10-16 20:41:03 -05001#pragma once
2
Zane Shelley3a02e242020-05-08 16:25:36 -05003#include <hei_chip.hpp>
4#include <hei_types.hpp>
Zane Shelley93b61ad2019-10-16 20:41:03 -05005
6namespace libhei
7{
8
9/**
Zane Shelley6722b5b2020-05-12 22:09:04 -050010 * @brief A signature represents an active attention from a single bit position
11 * from an isolation node within a chip.
Zane Shelley93b61ad2019-10-16 20:41:03 -050012 *
13 * The isolator will gather a list of all active attentions on a chip and return
14 * a list of signatures to the user application. The user application should be
15 * able to determine what actions to take based on these signatures.
16 */
17class Signature
18{
19 public: // Constructors, destructor, assignment, etc.
Zane Shelley84533532020-06-11 15:20:50 -050020 /**
21 * @brief Default contructor.
22 *
23 * In general the default constructor should not be used, but it is needed
24 * for some STL functions.
25 */
Zane Shelleydc7baeb2020-06-11 14:28:46 -050026 Signature() = default;
27
Zane Shelley93b61ad2019-10-16 20:41:03 -050028 /**
29 * @brief Constructor from components.
30 * @param i_chip The chip containing this register.
Zane Shelley6722b5b2020-05-12 22:09:04 -050031 * @param i_id The node ID.
Zane Shelley93b61ad2019-10-16 20:41:03 -050032 * @param i_instance The instance of this register.
33 * @param i_bit The target bit within this register.
34 * @param i_attnType The attention type reported by this bit.
35 */
Zane Shelley6722b5b2020-05-12 22:09:04 -050036 Signature(const Chip& i_chip, NodeId_t i_id, Instance_t i_instance,
Zane Shelley13b182b2020-05-07 20:23:45 -050037 BitPosition_t i_bit, AttentionType_t i_attnType) :
Zane Shelley7f7a42d2019-10-28 13:28:31 -050038 iv_chip(i_chip),
39 iv_id(i_id), iv_instance(i_instance), iv_bit(i_bit),
40 iv_attnType(i_attnType)
Zane Shelley93b61ad2019-10-16 20:41:03 -050041 {}
42
43 /** @brief Destructor. */
44 ~Signature() = default;
45
46 /** @brief Copy constructor. */
Zane Shelleyfe27b652019-10-28 11:33:07 -050047 Signature(const Signature&) = default;
Zane Shelley93b61ad2019-10-16 20:41:03 -050048
49 /** @brief Assignment operator. */
Zane Shelleyfe27b652019-10-28 11:33:07 -050050 Signature& operator=(const Signature&) = default;
Zane Shelley93b61ad2019-10-16 20:41:03 -050051
Zane Shelley7c8faa12019-10-28 22:26:28 -050052 private:
Zane Shelley5a78fa82022-09-16 16:49:58 -050053 Chip iv_chip; ///< Chip containing this register.
Patrick Williams2f7537d2023-05-10 07:51:39 -050054 NodeId_t iv_id = 0; ///< Node ID.
Zane Shelley5a78fa82022-09-16 16:49:58 -050055 Instance_t iv_instance = 0; ///< Instance of this register.
Patrick Williams2f7537d2023-05-10 07:51:39 -050056 BitPosition_t iv_bit = 0; ///< Target bit within this register.
Zane Shelley5a78fa82022-09-16 16:49:58 -050057
58 /** Attention type reported by this bit. */
Zane Shelleyb7005ca2023-03-24 15:23:59 -050059 AttentionType_t iv_attnType = ATTN_TYPE_CHIP_CS;
Zane Shelley93b61ad2019-10-16 20:41:03 -050060
61 public: // Member functions
Zane Shelley93b61ad2019-10-16 20:41:03 -050062 /** @return The chip containing this register. */
Zane Shelley7f7a42d2019-10-28 13:28:31 -050063 const Chip& getChip() const
64 {
65 return iv_chip;
66 }
Zane Shelley93b61ad2019-10-16 20:41:03 -050067
Zane Shelleyd280cca2020-11-13 17:08:24 -060068 /** @return The node ID. */
Zane Shelley6722b5b2020-05-12 22:09:04 -050069 NodeId_t getId() const
Zane Shelley7f7a42d2019-10-28 13:28:31 -050070 {
71 return iv_id;
72 }
Zane Shelley93b61ad2019-10-16 20:41:03 -050073
74 /** @return The instance of this register. */
Zane Shelley13b182b2020-05-07 20:23:45 -050075 Instance_t getInstance() const
Zane Shelley7f7a42d2019-10-28 13:28:31 -050076 {
77 return iv_instance;
78 }
Zane Shelley93b61ad2019-10-16 20:41:03 -050079
80 /** @return The target bit within this register. */
Zane Shelley13b182b2020-05-07 20:23:45 -050081 BitPosition_t getBit() const
Zane Shelley7f7a42d2019-10-28 13:28:31 -050082 {
83 return iv_bit;
84 }
Zane Shelley93b61ad2019-10-16 20:41:03 -050085
86 /** @return The attention type reported by this bit. */
Zane Shelley7f7a42d2019-10-28 13:28:31 -050087 AttentionType_t getAttnType() const
88 {
89 return iv_attnType;
90 }
Zane Shelley11b89942019-11-07 11:07:28 -060091
Zane Shelleyd280cca2020-11-13 17:08:24 -060092 /** @return A 32-bit integer containing the node ID, instance, and bit. This
93 * should be helpful for consistent logging and tracing. */
94 uint32_t toUint32() const
95 {
96 return getId() << 16 | getInstance() << 8 | getBit();
97 }
98
Zane Shelley11b89942019-11-07 11:07:28 -060099 public: // Operators
100 /** @brief Equals operator. */
101 bool operator==(const Signature& i_r) const
102 {
103 return (getChip() == i_r.getChip() && getId() == i_r.getId() &&
104 getInstance() == i_r.getInstance() &&
105 getBit() == i_r.getBit() && getAttnType() == i_r.getAttnType());
106 }
107
108 /** @brief Less than operator. */
109 bool operator<(const Signature& i_r) const
110 {
111 if (getChip() < i_r.getChip())
112 {
113 return true;
114 }
115 else if (getChip() == i_r.getChip())
116 {
117 if (getId() < i_r.getId())
118 {
119 return true;
120 }
121 else if (getId() == i_r.getId())
122 {
123 if (getInstance() < i_r.getInstance())
124 {
125 return true;
126 }
127 else if (getInstance() == i_r.getInstance())
128 {
129 if (getBit() < i_r.getBit())
130 {
131 return true;
132 }
133 else if (getBit() == i_r.getBit())
134 {
135 return (getAttnType() < i_r.getAttnType());
136 }
137 }
138 }
139 }
140
141 return false;
142 }
Zane Shelley93b61ad2019-10-16 20:41:03 -0500143};
144
145} // end namespace libhei