Linduino  1.3.0
Linear Technology Arduino-Compatible Demonstration Board
LT_PMBusDeviceLTC2974.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_PMBusDeviceLTC2974
48 */
49 
50 #ifndef LT_PMBusDeviceLTC2974_H_
51 #define LT_PMBusDeviceLTC2974_H_
52 
53 #include "LT_PMBusDeviceManager.h"
54 #include "../LTPSM_PartFaultLogs/LT_2974FaultLog.h"
55 
57 {
58  public:
59 
60  static uint32_t cap_;
61 
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
75  uint32_t capability //!< List of capabilities
76  )
77  {
78  return (cap_ & capability) == capability;
79  }
80 
81  char *getType(void)
82  {
83  uint8_t *model = (uint8_t *) calloc(8,1);
84  memcpy(model, "LTC2974", 7);
85  return (char *) model;
86  }
87 
88  uint8_t getNumPages(void)
89  {
90  return 4;
91  }
92 
94  {
95  uint16_t id;
97 
98  id = pmbus->readMfrSpecialId(address);
99  if ( (id & 0xFFF0) == 0x0210)
100  {
101  device = new LT_PMBusDeviceLTC2974(pmbus, address);
102  device->probeSpeed();
103  return device;
104  }
105  else
106  return NULL;
107  }
108 
110  {
111  LT_2974FaultLog *faultLog = new LT_2974FaultLog(pmbus_);
112  faultLog->enableFaultLog(address_);
113  delete faultLog;
114  }
115 
117  {
118  LT_2974FaultLog *faultLog = new LT_2974FaultLog(pmbus_);
119  faultLog->disableFaultLog(address_);
120  delete faultLog;
121  }
122 
123  bool hasFaultLog()
124  {
125  LT_2974FaultLog *faultLog = new LT_2974FaultLog(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_2974FaultLog *faultLog = new LT_2974FaultLog(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 
158  {
159  LT_2974FaultLog *faultLog = new LT_2974FaultLog(pmbus_);
160  if (faultLog->hasFaultLog(address_))
161  {
162  faultLog->clearFaultLog(address_);
163  pmbus_->smbus()->waitForAck(address_, 0x00);
165  delete faultLog;
166  }
167  else
168  {
169  delete faultLog;
170  }
171  }
172 };
173 
174 #endif /* LT_PMBusDeviceLTC2974_H_ */
static int id
Definition: rail_logger.ino:99
class that handles LTC2974 fault logs.
LTC PSM Manager Device.
void dumpBinary(Print *printer=0)
Dumps binary of the fault log to a Print inheriting object, or Serial if none specified.
char * getFaultLog()
Get the fault log text (call must free)
void disableFaultLog()
Disable the Fault Log.
LT_PMBus * pmbus_
LT_PMBusDeviceLTC2974(LT_PMBus *pmbus, uint8_t address)
static uint8_t address
Definition: DC2091A.ino:83
uint8_t waitForNotBusy(uint8_t address)
Read MFR_COMMON until not Busy.
Definition: LT_PMBus.cpp:3254
bool hasFaultLog(uint8_t address)
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_PMBus * pmbus()
void enableFaultLog(uint8_t address)
void enableFaultLog()
Enable the Fault Log.
void clearFaultLog()
Clear the Fault Log.
void release()
Frees the memory reserved for the fault log.
bool hasFaultLog()
Is there a fault log?
void read(uint8_t address)
Reads the fault log from the specified address, reserves memory to hold the data. ...
LT_SMBus * smbus()
Definition: LT_PMBus.h:401
void disableFaultLog(uint8_t address)
uint16_t readMfrSpecialId(uint8_t address)
Get speical ID.
Definition: LT_PMBus.cpp:3361
void clearFaultLog(uint8_t address)
static LT_PMBusDevice * detect(LT_PMBus *pmbus, uint8_t address)
ad5933_dev * device
Definition: CN-0413.ino:67
uint32_t getCapabilities()
Get the supported capabilities.
bool hasCapability(uint32_t capability)
Is/are these capability(s) supported?
PMBus communication.
Definition: LT_PMBus.h:370