| Linduino 1.3.0 Linear Technology Arduino-Compatible Demonstration Board

LT_PMBusDetect.h
Go to the documentation of this file.
1 /*!
2 LTC PSM Device Dector
3
4 @verbatim
5
6 The Device Detector queries a PMBus looking for Devices
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_PMBusDetect
48 */
49
50 #ifndef LT_PMBusDetect_H_
51 #define LT_PMBusDetect_H_
52
53 #include "LT_PMBusDevice.h"
54 #include "LT_PMBusRail.h"
55
56 class LT_PMBusDetect
57 {
58 protected:
59 LT_PMBus *pmbus_;
60 LT_PMBusDevice **devices_;
61 LT_PMBusRail **rails_;
62 unsigned int deviceCnt_;
63 unsigned int railCnt_;
64
65 public:
66 LT_PMBusDetect(LT_PMBus *pmbus);
67
68 //! Detect devices on bus
69 void detect();
70
71 LT_PMBusDevice **getDevices();
72
73 LT_PMBusRail **getRails();
74
75 };
76
77 #endif /* LT_PMBusDetect_H_ */
LT_PMBusDetect::pmbus_
LT_PMBus * pmbus_
Definition: LT_PMBusDetect.h:59
LT_PMBusDetect::LT_PMBusDetect
LT_PMBusDetect(LT_PMBus *pmbus)
Definition: LT_PMBusDetect.cpp:68
LT_PMBusDetect::getRails
LT_PMBusRail ** getRails()
Definition: LT_PMBusDetect.cpp:78
LT_PMBusDevice
Definition: LT_PMBusDevice.h:75
pmbus
static LT_PMBus * pmbus
Definition: DC2875A.ino:82
LT_PMBusRail.h
LTC PMBus Support.
LT_PMBusDetect::getDevices
LT_PMBusDevice ** getDevices()
Definition: LT_PMBusDetect.cpp:72
LT_PMBusDetect::rails_
LT_PMBusRail ** rails_
Definition: LT_PMBusDetect.h:61
LT_PMBusDetect::railCnt_
unsigned int railCnt_
Definition: LT_PMBusDetect.h:63
LT_PMBusDetect
Definition: LT_PMBusDetect.h:56
LT_PMBusDevice.h
Library Header File for LT_PMBusDevice.
LT_PMBusDetect::detect
void detect()
Detect devices on bus.
Definition: LT_PMBusDetect.cpp:85
LT_PMBusDetect::devices_
LT_PMBusDevice ** devices_
Definition: LT_PMBusDetect.h:60
LT_PMBusRail
PMBusRail communication. For Multiphase Rails.
Definition: LT_PMBusRail.h:72
LT_PMBusDetect::deviceCnt_
unsigned int deviceCnt_
Definition: LT_PMBusDetect.h:62
LT_PMBus
PMBus communication.
Definition: LT_PMBus.h:370