Skip to content

Commit

Permalink
Update Analyzer_API.md
Browse files Browse the repository at this point in the history
Updated reference to mData2 i the documentation.
  • Loading branch information
esal22 authored Dec 6, 2023
1 parent df63389 commit f32faf7
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/Analyzer_API.md
Original file line number Diff line number Diff line change
Expand Up @@ -480,7 +480,7 @@ public:
#### Frame Member Variables

* ```mStartingSampleInclusive``` and ```mEndingSampleInclusive``` are the sample numbers for the beginning and end of the ```Frame```. Frames may not overlap and they cannot share the same sample. For example, if a single clock edge ends one Frame, and starts a new Frame, then you’ll need to add one (+1) to the ```mStartingSampleInclusive``` of the second frame. A single Frame cannot have ```mStartingSampleInclusive``` and ```mEndingSampleInclusive``` be equal. They must be at least 1 sample apart.
* ```mData1``` and ```mData1``` Two 64-bit numbers to store Frame data data. For example, in SPI, one of these is used for the MISO result, and the other for the MISO result. Often times you’ll only use one of these variables.
* ```mData1``` and ```mData2``` Two 64-bit numbers to store Frame data data. For example, in SPI, one of these is used for the MISO result, and the other for the MISO result. Often times you’ll only use one of these variables.
* ```mType``` variable is intended to be used to save a custom-defined enum value, representing the type of ```Frame```. For example, CAN can have many different types of frames – header, data, CRC, etc. Serial only has one type, and it doesn’t use this member variable.
* ```mFlags``` is intended to be a holder for custom flags which might apply to frame. Note that this is not intended for use with a custom enum, but rather for individual bits that can be or’ed together. For example, in Serial, there is a flag for framing-error, and a flag for parity error.
```c++
Expand Down Expand Up @@ -1425,4 +1425,4 @@ U32 SpiSimulationDataGenerator::GenerateSimulationData( U64 largest_sample_reque
*simulation_channels = mSpiSimulationChannels.GetArray();
return mSpiSimulationChannels.GetCount();
}
```
```

0 comments on commit f32faf7

Please sign in to comment.