ngscopeclient 0.1-dev+51fbda87c
I2CRegisterDecoder.h
Go to the documentation of this file.
1/***********************************************************************************************************************
2* *
3* libscopeprotocols *
4* *
5* Copyright (c) 2012-2022 Andrew D. Zonenberg and contributors *
6* All rights reserved. *
7* *
8* Redistribution and use in source and binary forms, with or without modification, are permitted provided that the *
9* following conditions are met: *
10* *
11* * Redistributions of source code must retain the above copyright notice, this list of conditions, and the *
12* following disclaimer. *
13* *
14* * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the *
15* following disclaimer in the documentation and/or other materials provided with the distribution. *
16* *
17* * Neither the name of the author nor the names of any contributors may be used to endorse or promote products *
18* derived from this software without specific prior written permission. *
19* *
20* THIS SOFTWARE IS PROVIDED BY THE AUTHORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED *
21* TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL *
22* THE AUTHORS BE HELD LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES *
23* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR *
24* BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT *
25* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE *
26* POSSIBILITY OF SUCH DAMAGE. *
27* *
28***********************************************************************************************************************/
29
35#ifndef I2CRegisterDecoder_h
36#define I2CRegisterDecoder_h
37
38#include "../scopehal/PacketDecoder.h"
39
41{
42public:
43
44 enum EepromType
45 {
46 TYPE_SELECT_READ, //select with read bit, ack'd
47 TYPE_SELECT_WRITE, //select with write bit, ack'd
48 TYPE_ADDRESS,
49 TYPE_DATA
50 };
51
53 {}
54
55 I2CRegisterSymbol(EepromType type, uint32_t data)
56 : m_type(type)
57 , m_data(data)
58 {}
59
60 EepromType m_type;
61 uint32_t m_data;
62
63 bool operator== (const I2CRegisterSymbol& s) const
64 {
65 return (m_type == s.m_type) && (m_data == s.m_data);
66 }
67};
68
69class I2CRegisterWaveform : public SparseWaveform<I2CRegisterSymbol>
70{
71public:
72 I2CRegisterWaveform (FilterParameter& rawBytes) : SparseWaveform<I2CRegisterSymbol>(), m_rawBytes(rawBytes) {};
73 virtual std::string GetText(size_t) override;
74 virtual std::string GetColor(size_t) override;
75
76private:
77 FilterParameter& m_rawBytes;
78};
79
81{
82public:
83 I2CRegisterDecoder(const std::string& color);
84
85 virtual void Refresh() override;
86
87 static std::string GetProtocolName();
88
89 std::vector<std::string> GetHeaders() override;
90
91 virtual bool ValidateChannel(size_t i, StreamDescriptor stream) override;
92
93 PROTOCOL_DECODER_INITPROC(I2CRegisterDecoder)
94
95protected:
96 std::string m_addrbytesname;
97 std::string m_baseaddrname;
98};
99
100#endif
A parameter to a filter.
Definition: FilterParameter.h:86
Definition: I2CRegisterDecoder.h:81
virtual void Refresh() override
Evaluates a filter graph node.
Definition: I2CRegisterDecoder.cpp:89
Definition: I2CRegisterDecoder.h:41
Definition: I2CRegisterDecoder.h:70
virtual std::string GetText(size_t) override
Returns the text representation of a given protocol sample.
Definition: I2CRegisterDecoder.cpp:442
virtual std::string GetColor(size_t) override
Returns the displayed color (in HTML #rrggbb or #rrggbbaa notation) of a given protocol sample.
Definition: I2CRegisterDecoder.cpp:421
Definition: PacketDecoder.h:85
A waveform sampled at irregular intervals.
Definition: Waveform.h:460
Descriptor for a single stream coming off a channel.
Definition: StreamDescriptor.h:46