Zane Shelley | 93b61ad | 2019-10-16 20:41:03 -0500 | [diff] [blame] | 1 | #pragma once |
| 2 | |
Zane Shelley | 3a02e24 | 2020-05-08 16:25:36 -0500 | [diff] [blame] | 3 | #include <hei_chip.hpp> |
| 4 | #include <hei_types.hpp> |
Zane Shelley | 93b61ad | 2019-10-16 20:41:03 -0500 | [diff] [blame] | 5 | |
| 6 | namespace libhei |
| 7 | { |
| 8 | |
| 9 | /** |
Zane Shelley | 6722b5b | 2020-05-12 22:09:04 -0500 | [diff] [blame] | 10 | * @brief A signature represents an active attention from a single bit position |
| 11 | * from an isolation node within a chip. |
Zane Shelley | 93b61ad | 2019-10-16 20:41:03 -0500 | [diff] [blame] | 12 | * |
| 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 | */ |
| 17 | class Signature |
| 18 | { |
| 19 | public: // Constructors, destructor, assignment, etc. |
Zane Shelley | 8453353 | 2020-06-11 15:20:50 -0500 | [diff] [blame] | 20 | /** |
| 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 Shelley | dc7baeb | 2020-06-11 14:28:46 -0500 | [diff] [blame] | 26 | Signature() = default; |
| 27 | |
Zane Shelley | 93b61ad | 2019-10-16 20:41:03 -0500 | [diff] [blame] | 28 | /** |
| 29 | * @brief Constructor from components. |
| 30 | * @param i_chip The chip containing this register. |
Zane Shelley | 6722b5b | 2020-05-12 22:09:04 -0500 | [diff] [blame] | 31 | * @param i_id The node ID. |
Zane Shelley | 93b61ad | 2019-10-16 20:41:03 -0500 | [diff] [blame] | 32 | * @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 Shelley | 6722b5b | 2020-05-12 22:09:04 -0500 | [diff] [blame] | 36 | Signature(const Chip& i_chip, NodeId_t i_id, Instance_t i_instance, |
Zane Shelley | 13b182b | 2020-05-07 20:23:45 -0500 | [diff] [blame] | 37 | BitPosition_t i_bit, AttentionType_t i_attnType) : |
Zane Shelley | 7f7a42d | 2019-10-28 13:28:31 -0500 | [diff] [blame] | 38 | iv_chip(i_chip), |
| 39 | iv_id(i_id), iv_instance(i_instance), iv_bit(i_bit), |
| 40 | iv_attnType(i_attnType) |
Zane Shelley | 93b61ad | 2019-10-16 20:41:03 -0500 | [diff] [blame] | 41 | {} |
| 42 | |
| 43 | /** @brief Destructor. */ |
| 44 | ~Signature() = default; |
| 45 | |
| 46 | /** @brief Copy constructor. */ |
Zane Shelley | fe27b65 | 2019-10-28 11:33:07 -0500 | [diff] [blame] | 47 | Signature(const Signature&) = default; |
Zane Shelley | 93b61ad | 2019-10-16 20:41:03 -0500 | [diff] [blame] | 48 | |
| 49 | /** @brief Assignment operator. */ |
Zane Shelley | fe27b65 | 2019-10-28 11:33:07 -0500 | [diff] [blame] | 50 | Signature& operator=(const Signature&) = default; |
Zane Shelley | 93b61ad | 2019-10-16 20:41:03 -0500 | [diff] [blame] | 51 | |
Zane Shelley | 7c8faa1 | 2019-10-28 22:26:28 -0500 | [diff] [blame] | 52 | private: |
Zane Shelley | 5a78fa8 | 2022-09-16 16:49:58 -0500 | [diff] [blame] | 53 | Chip iv_chip; ///< Chip containing this register. |
| 54 | NodeId_t iv_id = 0; ///< Node ID. |
| 55 | Instance_t iv_instance = 0; ///< Instance of this register. |
| 56 | BitPosition_t iv_bit = 0; ///< Target bit within this register. |
| 57 | |
| 58 | /** Attention type reported by this bit. */ |
Zane Shelley | b7005ca | 2023-03-24 15:23:59 -0500 | [diff] [blame^] | 59 | AttentionType_t iv_attnType = ATTN_TYPE_CHIP_CS; |
Zane Shelley | 93b61ad | 2019-10-16 20:41:03 -0500 | [diff] [blame] | 60 | |
| 61 | public: // Member functions |
Zane Shelley | 93b61ad | 2019-10-16 20:41:03 -0500 | [diff] [blame] | 62 | /** @return The chip containing this register. */ |
Zane Shelley | 7f7a42d | 2019-10-28 13:28:31 -0500 | [diff] [blame] | 63 | const Chip& getChip() const |
| 64 | { |
| 65 | return iv_chip; |
| 66 | } |
Zane Shelley | 93b61ad | 2019-10-16 20:41:03 -0500 | [diff] [blame] | 67 | |
Zane Shelley | d280cca | 2020-11-13 17:08:24 -0600 | [diff] [blame] | 68 | /** @return The node ID. */ |
Zane Shelley | 6722b5b | 2020-05-12 22:09:04 -0500 | [diff] [blame] | 69 | NodeId_t getId() const |
Zane Shelley | 7f7a42d | 2019-10-28 13:28:31 -0500 | [diff] [blame] | 70 | { |
| 71 | return iv_id; |
| 72 | } |
Zane Shelley | 93b61ad | 2019-10-16 20:41:03 -0500 | [diff] [blame] | 73 | |
| 74 | /** @return The instance of this register. */ |
Zane Shelley | 13b182b | 2020-05-07 20:23:45 -0500 | [diff] [blame] | 75 | Instance_t getInstance() const |
Zane Shelley | 7f7a42d | 2019-10-28 13:28:31 -0500 | [diff] [blame] | 76 | { |
| 77 | return iv_instance; |
| 78 | } |
Zane Shelley | 93b61ad | 2019-10-16 20:41:03 -0500 | [diff] [blame] | 79 | |
| 80 | /** @return The target bit within this register. */ |
Zane Shelley | 13b182b | 2020-05-07 20:23:45 -0500 | [diff] [blame] | 81 | BitPosition_t getBit() const |
Zane Shelley | 7f7a42d | 2019-10-28 13:28:31 -0500 | [diff] [blame] | 82 | { |
| 83 | return iv_bit; |
| 84 | } |
Zane Shelley | 93b61ad | 2019-10-16 20:41:03 -0500 | [diff] [blame] | 85 | |
| 86 | /** @return The attention type reported by this bit. */ |
Zane Shelley | 7f7a42d | 2019-10-28 13:28:31 -0500 | [diff] [blame] | 87 | AttentionType_t getAttnType() const |
| 88 | { |
| 89 | return iv_attnType; |
| 90 | } |
Zane Shelley | 11b8994 | 2019-11-07 11:07:28 -0600 | [diff] [blame] | 91 | |
Zane Shelley | d280cca | 2020-11-13 17:08:24 -0600 | [diff] [blame] | 92 | /** @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 Shelley | 11b8994 | 2019-11-07 11:07:28 -0600 | [diff] [blame] | 99 | 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 Shelley | 93b61ad | 2019-10-16 20:41:03 -0500 | [diff] [blame] | 143 | }; |
| 144 | |
| 145 | } // end namespace libhei |