Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / phosphor-time-manager / 7d05550d0ee07748e6311aace87f786428618fc8
commit7d05550d0ee07748e6311aace87f786428618fc8[log] [tgz]
authorLei YU <mine260309@gmail.com>Wed Oct 18 20:43:39 2017 +0800
committerLei YU <mine260309@gmail.com>Wed Oct 18 20:46:13 2017 +0800
tree5c0cfb83d85a0c4ebf2e8bd173eb0d11f3d15ac0
parentdebe1d8f47bab3d61b3340c84f802f1dc6388ca0 [diff]
Fix table format in README.md

Github flavored markdown requires a blank line between text and table.

Change-Id: I55d6b964b9fb699e7b7a57cbd3b8f7b54a617947
Signed-off-by: Lei YU <mine260309@gmail.com>
1 file changed
tree: 5c0cfb83d85a0c4ebf2e8bd173eb0d11f3d15ac0
  1. test/
  2. xyz/
  3. .gitignore
  4. bmc_epoch.cpp
  5. bmc_epoch.hpp
  6. bmc_time_change_listener.hpp
  7. bootstrap.sh
  8. configure.ac
  9. elog-errors.hpp
  10. epoch_base.cpp
  11. epoch_base.hpp
  12. host_epoch.cpp
  13. host_epoch.hpp
  14. LICENSE
  15. main.cpp
  16. Makefile.am
  17. manager.cpp
  18. manager.hpp
  19. property_change_listener.hpp
  20. README.md
  21. settings.cpp
  22. settings.hpp
  23. types.hpp
  24. utils.cpp
  25. utils.hpp
README.md

Introduction

phosphor-time-manager is the time manager service that implements dbus interface xyz/openbmc_project/Time/EpochTime.interface.yaml. User can get or set the BMC's or HOST's time via this interface.

General usage

The service xyz.openbmc_project.Time.Manager provides two objects on dbus:

  • /xyz/openbmc_project/time/bmc
  • /xyz/openbmc_project/time/host

where each object implements interface xyz.openbmc_project.Time.EpochTime.

User can directly get or set the property Elasped of the objects to get or set the time. For example on an authenticated session:

  • To get BMC's time:
    ### With busctl on BMC
busctl get-property xyz.openbmc_project.Time.Manager \
    /xyz/openbmc_project/time/bmc xyz.openbmc_project.Time.EpochTime Elapsed

### With REST API on remote host
curl -b cjar -k https://bmc-ip/xyz/openbmc_project/time/bmc
  • To set HOST's time:
    ### With busctl on BMC
busctl set-property xyz.openbmc_project.Time.Manager \
    /xyz/openbmc_project/time/host xyz.openbmc_project.Time.EpochTime \
    Elapsed t <value-in-microseconds>

### With REST API on remote host
curl -b cjar -k -H "Content-Type: application/json" -X PUT \
    -d '{"data": 1487304700000000}' \
    https://bmc-ip/xyz/openbmc_project/time/host/attr/Elapsed

Time settings

Getting BMC or HOST time is always allowed, but setting the time may not be allowed depending on below two settings in settings manager.

  • TimeSyncMethod
    • NTP: Time is set via NTP server.
    • MANUAL: Time is set manually.
  • TimeOwner
    • BMC: BMC owns the time and can set the time.
    • HOST: Host owns the time and can set the time.
    • SPLIT: BMC and Host owns separate time.
    • BOTH: Both BMC and Host can set the time.

A summary of which cases the time can be set on BMC or HOST:

ModeOwnerSet BMC TimeSet Host Time
NTPBMCFail to setNot allowed
NTPHOSTNot allowedNot allowed
NTPSPLITFail to setOK
NTPBOTHFail to setNot allowed
MANUALBMCOKNot allowed
MANUALHOSTNot allowedOK
MANUALSPLITOKOK
MANUALBOTHOKOK

Special note on host on

When host is on, the changes of the above time mode/owner are not applied but deferred. The changes of the mode/owner are saved to persistent storage.

When host is off, the saved mode/owner are read from persistent storage and are applied.

Note: user can set the time mode and owner in settings daemon at any time, but time manager applying them is governed by the above condition.