@@ -168,7 +168,32 @@ class profiling_impl;
168
168
class profiling : public detail ::pimpl<profiling_impl>
169
169
{
170
170
public:
171
- enum class profiling_option : int { io_total_stream_running_to_idle_cycles = 0 , io_stream_start_to_bytes_transferred_cycles = 1 , io_stream_start_difference_cycles = 2 , io_stream_running_event_count = 3 };
171
+
172
+ /* *
173
+ * @enum profiliing_options - contains the enumerated options for performance
174
+ * profiling using PLIO and GMIO objects.
175
+ *
176
+ * @var io_total_stream_running_to_idle_cycles
177
+ * Total clock cycles in between the stream running event and the stream
178
+ * idle event of the stream port in the interface tile.
179
+ * @var io_stream_start_to_bytes_transferred_cycles
180
+ * The clock cycles in between the first stream running event to the event that
181
+ * the specified bytes are transferred through the stream port in the interface tile.
182
+ * @var io_stream_start_difference_cycles
183
+ * The clock cycles elapsed between the first stream running events of
184
+ * the two platform I/O objects.
185
+ * @var io_stream_running_event_count
186
+ * Number of stream running events
187
+ *
188
+ * Please refer UG1079 for more details.
189
+ */
190
+ enum class profiling_option : int
191
+ {
192
+ io_total_stream_running_to_idle_cycles = 0 ,
193
+ io_stream_start_to_bytes_transferred_cycles = 1 ,
194
+ io_stream_start_difference_cycles = 2 ,
195
+ io_stream_running_event_count = 3
196
+ };
172
197
173
198
profiling () = default ;
174
199
@@ -194,6 +219,8 @@ class profiling : public detail::pimpl<profiling_impl>
194
219
* @param value
195
220
* The number of bytes to trigger the profiling event.
196
221
*
222
+ * Please refer UG1079 for more details.
223
+ *
197
224
* This function configures the performance counters in AI Engine by given
198
225
* port names and value. The port names and value will have different
199
226
* meanings on different options.
@@ -215,9 +242,6 @@ class profiling : public detail::pimpl<profiling_impl>
215
242
*/
216
243
void
217
244
stop () const ;
218
-
219
- private:
220
- std::shared_ptr<profiling_impl> impl;
221
245
};
222
246
223
247
}} // aie, xrt
0 commit comments