| Linduino 1.3.0 Linear Technology Arduino-Compatible Demonstration Board

LT_PMBusDeviceLTC3887.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_PMBusDeviceLTC3887
48 */
49
50 #ifndef LT_PMBusDeviceLTC3887_H_
51 #define LT_PMBusDeviceLTC3887_H_
52
53 #include "LT_PMBusDeviceController.h"
54
55 class LT_PMBusDeviceLTC3887 : public LT_PMBusDeviceController
56 {
57 public:
58
59 static uint32_t cap_;
60
61 LT_PMBusDeviceLTC3887(LT_PMBus *pmbus, uint8_t address) : LT_PMBusDeviceController(pmbus, address, 2)
62 {
63 }
64
65 uint32_t getCapabilities (
66 )
67 {
68 return cap_;
69 }
70
71 //! Is/are these capability(s) supported?
72 //! @return true if yes
73 bool hasCapability(
74 uint32_t capability //!< List of capabilities
75 )
76 {
77 return (cap_ & capability) == capability;
78 }
79
80 static LT_PMBusDevice *detect(LT_PMBus *pmbus, uint8_t address)
81 {
82 uint16_t id;
83 LT_PMBusDeviceLTC3887 *device;
84
85 id = pmbus->readMfrSpecialId(address);
86 if ( (id & 0xFFF0) == 0x4700)
87 {
88 if (pmbus->getRailAddress(address) != address)
89 {
90 device = new LT_PMBusDeviceLTC3887(pmbus, address);
91 device->probeSpeed();
92 return device;
93 }
94 else
95 return NULL;
96 }
97 else
98 return NULL;
99 }
100
101 uint8_t getNumPages(void)
102 {
103 return 2;
104 }
105
106 };
107
108 #endif /* LT_PMBusDeviceLTC3887_H_ */
id
static int id
Definition: rail_logger.ino:99
LT_PMBusDevice
Definition: LT_PMBusDevice.h:75
LT_PMBusDeviceLTC3887::getNumPages
uint8_t getNumPages(void)
Definition: LT_PMBusDeviceLTC3887.h:101
LT_PMBusDeviceLTC3887::getCapabilities
uint32_t getCapabilities()
Get the supported capabilities.
Definition: LT_PMBusDeviceLTC3887.h:65
address
static uint8_t address
Definition: DC2091A.ino:83
LT_PMBusDeviceLTC3887::hasCapability
bool hasCapability(uint32_t capability)
Is/are these capability(s) supported?
Definition: LT_PMBusDeviceLTC3887.h:73
LT_PMBusDeviceController.h
LTC PSM Controller Device.
LT_PMBusDevice::pmbus
LT_PMBus * pmbus()
Definition: LT_PMBusDevice.cpp:70
LT_PMBusDeviceController
Definition: LT_PMBusDeviceController.h:56
LT_PMBusDevice::probeSpeed
void probeSpeed()
Definition: LT_PMBusDevice.cpp:57
LT_PMBusDeviceLTC3887::LT_PMBusDeviceLTC3887
LT_PMBusDeviceLTC3887(LT_PMBus *pmbus, uint8_t address)
Definition: LT_PMBusDeviceLTC3887.h:61
LT_PMBus::readMfrSpecialId
uint16_t readMfrSpecialId(uint8_t address)
Get speical ID.
Definition: LT_PMBus.cpp:3361
device
ad5933_dev * device
Definition: CN-0413.ino:67
LT_PMBusDeviceLTC3887
Definition: LT_PMBusDeviceLTC3887.h:55
LT_PMBusDeviceLTC3887::cap_
static uint32_t cap_
Definition: LT_PMBusDeviceLTC3887.h:59
LT_PMBusDeviceLTC3887::detect
static LT_PMBusDevice * detect(LT_PMBus *pmbus, uint8_t address)
Definition: LT_PMBusDeviceLTC3887.h:80
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