| Linduino 1.3.0 Linear Technology Arduino-Compatible Demonstration Board

LT_PMBusDeviceLTM4676.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_PMBusDeviceLTM4676
48 */
49
50 #ifndef LT_PMBusDeviceLTM4676_H_
51 #define LT_PMBusDeviceLTM4676_H_
52
53 #include "LT_PMBusDeviceController.h"
54 #include "../LTPSM_PartFaultLogs/LT_3880FaultLog.h"
55
56 class LT_PMBusDeviceLTM4676 : public LT_PMBusDeviceController
57 {
58 public:
59
60 static uint32_t cap_;
61
62 LT_PMBusDeviceLTM4676(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_PMBusDeviceLTM4676 *device;
85
86 id = pmbus->readMfrSpecialId(address);
87 if ( (id & 0xFFF0) == 0x4400
88 || (id & 0xFFF0) == 0x4480
89 || (id & 0xFFF0) == 0x47E0)
90 {
91 if (pmbus->getRailAddress(address) != address)
92 {
93 device = new LT_PMBusDeviceLTM4676(pmbus, address);
94 device->probeSpeed();
95 return device;
96 }
97 else
98 return NULL;
99 }
100 else
101 return NULL;
102 }
103
104 uint8_t getNumPages(void)
105 {
106 return 2;
107 }
108
109 void enableFaultLog()
110 {
111 LT_3880FaultLog *faultLog = new LT_3880FaultLog(pmbus_);
112 faultLog->enableFaultLog(address_);
113 delete faultLog;
114 }
115
116 void disableFaultLog()
117 {
118 LT_3880FaultLog *faultLog = new LT_3880FaultLog(pmbus_);
119 faultLog->disableFaultLog(address_);
120 delete faultLog;
121 }
122
123 bool hasFaultLog()
124 {
125 LT_3880FaultLog *faultLog = new LT_3880FaultLog(pmbus_);
126 if (faultLog->hasFaultLog(address_))
127 {
128 delete faultLog;
129 return true;
130 }
131 else
132 {
133 delete faultLog;
134 return false;
135 }
136 }
137
138 char *getFaultLog()
139 {
140 LT_3880FaultLog *faultLog = new LT_3880FaultLog(pmbus_);
141 if (faultLog->hasFaultLog(address_))
142 {
143 faultLog->read(address_);
144 // faultLog->print(&Serial);
145 faultLog->dumpBinary(&Serial);
146 faultLog->release();
147 delete faultLog;
148 return NULL;
149 }
150 else
151 {
152 delete faultLog;
153 return NULL;
154 }
155 }
156
157 void clearFaultLog()
158 {
159 LT_3880FaultLog *faultLog = new LT_3880FaultLog(pmbus_);
160 if (faultLog->hasFaultLog(address_))
161 {
162 faultLog->clearFaultLog(address_);
163 pmbus_->smbus()->waitForAck(address_, 0x00);
164 pmbus_->waitForNotBusy(address_);
165 delete faultLog;
166 }
167 else
168 {
169 delete faultLog;
170 }
171 }
172 };
173
174 #endif /* LT_PMBusDeviceLTM4676_H_ */
id
static int id
Definition: rail_logger.ino:99
LT_PMBusDevice::address_
uint8_t address_
Definition: LT_PMBusDevice.h:79
LT_3880FaultLog
class that handles LTC3880 fault logs.
Definition: LT_3880FaultLog.h:61
LT_PMBusDevice
Definition: LT_PMBusDevice.h:75
LT_PMBusDeviceLTM4676::getCapabilities
uint32_t getCapabilities()
Get the supported capabilities.
Definition: LT_PMBusDeviceLTM4676.h:66
LT_PMBusDevice::pmbus_
LT_PMBus * pmbus_
Definition: LT_PMBusDevice.h:78
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_PMBusDeviceLTM4676::detect
static LT_PMBusDevice * detect(LT_PMBus *pmbus, uint8_t address)
Definition: LT_PMBusDeviceLTM4676.h:81
LT_FaultLog::enableFaultLog
void enableFaultLog(uint8_t address)
Definition: LT_FaultLog.cpp:141
LT_PMBusDeviceLTM4676::LT_PMBusDeviceLTM4676
LT_PMBusDeviceLTM4676(LT_PMBus *pmbus, uint8_t address)
Definition: LT_PMBusDeviceLTM4676.h:62
LT_3880FaultLog::dumpBinary
void dumpBinary(Print *printer=0)
Dumps binary of the fault log to a Print inheriting object, or Serial if none specified.
Definition: LT_3880FaultLog.cpp:108
LT_PMBusDeviceLTM4676
Definition: LT_PMBusDeviceLTM4676.h:56
LT_PMBusDeviceLTM4676::clearFaultLog
void clearFaultLog()
Clear the Fault Log.
Definition: LT_PMBusDeviceLTM4676.h:157
LT_3880FaultLog::release
void release()
Frees the memory reserved for the fault log.
Definition: LT_3880FaultLog.cpp:92
LT_PMBusDeviceLTM4676::hasFaultLog
bool hasFaultLog()
Is there a fault log?
Definition: LT_PMBusDeviceLTM4676.h:123
LT_PMBusDeviceLTM4676::disableFaultLog
void disableFaultLog()
Disable the Fault Log.
Definition: LT_PMBusDeviceLTM4676.h:116
LT_PMBusDeviceLTM4676::cap_
static uint32_t cap_
Definition: LT_PMBusDeviceLTM4676.h:60
LT_PMBus::smbus
LT_SMBus * smbus()
Definition: LT_PMBus.h:401
LT_PMBusDeviceController
Definition: LT_PMBusDeviceController.h:56
LT_PMBusDeviceLTM4676::hasCapability
bool hasCapability(uint32_t capability)
Is/are these capability(s) supported?
Definition: LT_PMBusDeviceLTM4676.h:74
LT_PMBusDevice::probeSpeed
void probeSpeed()
Definition: LT_PMBusDevice.cpp:57
LT_FaultLog::disableFaultLog
void disableFaultLog(uint8_t address)
Definition: LT_FaultLog.cpp:182
LT_3880FaultLog::read
void read(uint8_t address)
Reads the fault log from the specified address, reserves memory to hold the data. ...
Definition: LT_3880FaultLog.cpp:76
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
device
ad5933_dev * device
Definition: CN-0413.ino:67
LT_PMBusDeviceLTM4676::getNumPages
uint8_t getNumPages(void)
Definition: LT_PMBusDeviceLTM4676.h:104
LT_PMBus::getRailAddress
uint8_t getRailAddress(uint8_t address)
Get the rail address of a Controller.
Definition: LT_PMBus.cpp:3131
LT_PMBusDeviceLTM4676::getFaultLog
char * getFaultLog()
Get the fault log text (call must free)
Definition: LT_PMBusDeviceLTM4676.h:138
LT_PMBusDeviceLTM4676::enableFaultLog
void enableFaultLog()
Enable the Fault Log.
Definition: LT_PMBusDeviceLTM4676.h:109
LT_PMBus
PMBus communication.
Definition: LT_PMBus.h:370