| Linduino 1.3.0 Linear Technology Arduino-Compatible Demonstration Board

LT_PMBusDeviceLTC3882.h
Go to the documentation of this file.
1 /*!
2 LTC PSM Device
3
4 @verbatim
5
6 Representation of a device and its capabilities.
7
8 @endverbatim
9
10
11 Copyright 2018(c) Analog Devices, Inc.
12
13 All rights reserved.
14
15 Redistribution and use in source and binary forms, with or without
16 modification, are permitted provided that the following conditions are met:
17 - Redistributions of source code must retain the above copyright
18 notice, this list of conditions and the following disclaimer.
19 - Redistributions in binary form must reproduce the above copyright
20 notice, this list of conditions and the following disclaimer in
21 the documentation and/or other materials provided with the
22 distribution.
23 - Neither the name of Analog Devices, Inc. nor the names of its
24 contributors may be used to endorse or promote products derived
25 from this software without specific prior written permission.
26 - The use of this software may or may not infringe the patent rights
27 of one or more patent holders. This license does not release you
28 from the requirement that you obtain separate licenses from these
29 patent holders to use this software.
30 - Use of the software either in source or binary form, must be run
31 on or directly connected to an Analog Devices Inc. component.
32
33 THIS SOFTWARE IS PROVIDED BY ANALOG DEVICES "AS IS" AND ANY EXPRESS OR
34 IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, NON-INFRINGEMENT,
35 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
36 IN NO EVENT SHALL ANALOG DEVICES BE LIABLE FOR ANY DIRECT, INDIRECT,
37 INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
38 LIMITED TO, INTELLECTUAL PROPERTY RIGHTS, PROCUREMENT OF SUBSTITUTE GOODS OR
39 SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
40 CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
41 OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
42 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
43 */
44
45 /*! @file
46 @ingroup LT_PMBusDevice
47 Library Header File for LT_PMBusDeviceLTC3882
48 */
49
50 #ifndef LT_PMBusDeviceLTC3882_H_
51 #define LT_PMBusDeviceLTC3882_H_
52
53 #include "LT_PMBusDeviceController.h"
54 #include "../LTPSM_PartFaultLogs/LT_3882FaultLog.h"
55
56 class LT_PMBusDeviceLTC3882 : public LT_PMBusDeviceController
57 {
58 public:
59
60 static uint32_t cap_;
61
62 LT_PMBusDeviceLTC3882(LT_PMBus *pmbus, uint8_t address) : LT_PMBusDeviceController(pmbus, address, 2)
63 {
64 }
65
66 uint32_t getCapabilities (
67 )
68 {
69 return cap_;
70 }
71
72 //! Is/are these capability(s) supported?
73 //! @return true if yes
74 bool hasCapability(
75 uint32_t capability //!< List of capabilities
76 )
77 {
78 return (cap_ & capability) == capability;
79 }
80
81 static LT_PMBusDevice *detect(LT_PMBus *pmbus, uint8_t address)
82 {
83 uint16_t id;
84 LT_PMBusDeviceLTC3882 *device;
85
86 id = pmbus->readMfrSpecialId(address);
87 if ( (id & 0xFFF0) == 0x4200
88 || (id & 0xFFF0) == 0x4240)
89 {
90 if (pmbus->getRailAddress(address) != address)
91 {
92 device = new LT_PMBusDeviceLTC3882(pmbus, address);
93 device->probeSpeed();
94 return device;
95 }
96 else
97 return NULL;
98 }
99 else
100 return NULL;
101 }
102
103 uint8_t getNumPages(void)
104 {
105 return 2;
106 }
107
108 void enableFaultLog()
109 {
110 LT_3882FaultLog *faultLog = new LT_3882FaultLog(pmbus_);
111 faultLog->enableFaultLog(address_);
112 delete faultLog;
113 }
114
115 void disableFaultLog()
116 {
117 LT_3882FaultLog *faultLog = new LT_3882FaultLog(pmbus_);
118 faultLog->disableFaultLog(address_);
119 delete faultLog;
120 }
121
122 bool hasFaultLog()
123 {
124 LT_3882FaultLog *faultLog = new LT_3882FaultLog(pmbus_);
125 if (faultLog->hasFaultLog(address_))
126 {
127 delete faultLog;
128 return true;
129 }
130 else
131 {
132 delete faultLog;
133 return false;
134 }
135 }
136
137 char *getFaultLog()
138 {
139 LT_3882FaultLog *faultLog = new LT_3882FaultLog(pmbus_);
140 if (faultLog->hasFaultLog(address_))
141 {
142 faultLog->read(address_);
143 // faultLog->print(&Serial);
144 faultLog->dumpBinary(&Serial);
145 faultLog->release();
146 delete faultLog;
147 return NULL;
148 }
149 else
150 {
151 delete faultLog;
152 return NULL;
153 }
154 }
155
156 void clearFaultLog()
157 {
158 LT_3882FaultLog *faultLog = new LT_3882FaultLog(pmbus_);
159 if (faultLog->hasFaultLog(address_))
160 {
161 faultLog->clearFaultLog(address_);
162 pmbus_->smbus()->waitForAck(address_, 0x00);
163 pmbus_->waitForNotBusy(address_);
164 delete faultLog;
165 }
166 else
167 {
168 delete faultLog;
169 }
170 }
171 };
172
173 #endif /* LT_PMBusDeviceLTC3882_H_ */
id
static int id
Definition: rail_logger.ino:99
LT_PMBusDeviceLTC3882::getCapabilities
uint32_t getCapabilities()
Get the supported capabilities.
Definition: LT_PMBusDeviceLTC3882.h:66
LT_3882FaultLog::read
void read(uint8_t address)
Reads the fault log from the specified address, reserves memory to hold the data. ...
Definition: LT_3882FaultLog.cpp:75
LT_PMBusDevice::address_
uint8_t address_
Definition: LT_PMBusDevice.h:79
LT_PMBusDeviceLTC3882::LT_PMBusDeviceLTC3882
LT_PMBusDeviceLTC3882(LT_PMBus *pmbus, uint8_t address)
Definition: LT_PMBusDeviceLTC3882.h:62
LT_3882FaultLog
class that handles LTC3882 fault logs.
Definition: LT_3882FaultLog.h:61
LT_PMBusDevice
Definition: LT_PMBusDevice.h:75
LT_PMBusDeviceLTC3882::getFaultLog
char * getFaultLog()
Get the fault log text (call must free)
Definition: LT_PMBusDeviceLTC3882.h:137
LT_PMBusDeviceLTC3882::cap_
static uint32_t cap_
Definition: LT_PMBusDeviceLTC3882.h:60
LT_PMBusDeviceLTC3882::getNumPages
uint8_t getNumPages(void)
Definition: LT_PMBusDeviceLTC3882.h:103
LT_PMBusDeviceLTC3882::detect
static LT_PMBusDevice * detect(LT_PMBus *pmbus, uint8_t address)
Definition: LT_PMBusDeviceLTC3882.h:81
LT_PMBusDevice::pmbus_
LT_PMBus * pmbus_
Definition: LT_PMBusDevice.h:78
LT_PMBusDeviceLTC3882
Definition: LT_PMBusDeviceLTC3882.h:56
address
static uint8_t address
Definition: DC2091A.ino:83
LT_PMBus::waitForNotBusy
uint8_t waitForNotBusy(uint8_t address)
Read MFR_COMMON until not Busy.
Definition: LT_PMBus.cpp:3254
LT_FaultLog::hasFaultLog
bool hasFaultLog(uint8_t address)
Definition: LT_FaultLog.cpp:101
LT_PMBusDeviceController.h
LTC PSM Controller Device.
LT_SMBus::waitForAck
virtual uint8_t waitForAck(uint8_t address, uint8_t command)=0
Read with the address and command in loop until ack, then issue stop.
LT_PMBusDevice::pmbus
LT_PMBus * pmbus()
Definition: LT_PMBusDevice.cpp:70
LT_FaultLog::enableFaultLog
void enableFaultLog(uint8_t address)
Definition: LT_FaultLog.cpp:141
LT_PMBusDeviceLTC3882::enableFaultLog
void enableFaultLog()
Enable the Fault Log.
Definition: LT_PMBusDeviceLTC3882.h:108
LT_PMBusDeviceLTC3882::hasCapability
bool hasCapability(uint32_t capability)
Is/are these capability(s) supported?
Definition: LT_PMBusDeviceLTC3882.h:74
LT_3882FaultLog::release
void release()
Frees the memory reserved for the fault log.
Definition: LT_3882FaultLog.cpp:91
LT_PMBus::smbus
LT_SMBus * smbus()
Definition: LT_PMBus.h:401
LT_PMBusDeviceController
Definition: LT_PMBusDeviceController.h:56
LT_PMBusDeviceLTC3882::hasFaultLog
bool hasFaultLog()
Is there a fault log?
Definition: LT_PMBusDeviceLTC3882.h:122
LT_3882FaultLog::dumpBinary
void dumpBinary(Print *printer=0)
Dumps binary of the fault log to a Print inheriting object, or Serial if none specified.
Definition: LT_3882FaultLog.cpp:107
LT_PMBusDeviceLTC3882::disableFaultLog
void disableFaultLog()
Disable the Fault Log.
Definition: LT_PMBusDeviceLTC3882.h:115
LT_PMBusDevice::probeSpeed
void probeSpeed()
Definition: LT_PMBusDevice.cpp:57
LT_FaultLog::disableFaultLog
void disableFaultLog(uint8_t address)
Definition: LT_FaultLog.cpp:182
LT_PMBus::readMfrSpecialId
uint16_t readMfrSpecialId(uint8_t address)
Get speical ID.
Definition: LT_PMBus.cpp:3361
LT_FaultLog::clearFaultLog
void clearFaultLog(uint8_t address)
Definition: LT_FaultLog.cpp:240
LT_PMBusDeviceLTC3882::clearFaultLog
void clearFaultLog()
Clear the Fault Log.
Definition: LT_PMBusDeviceLTC3882.h:156
device
ad5933_dev * device
Definition: CN-0413.ino:67
LT_PMBus::getRailAddress
uint8_t getRailAddress(uint8_t address)
Get the rail address of a Controller.
Definition: LT_PMBus.cpp:3131
LT_PMBus
PMBus communication.
Definition: LT_PMBus.h:370