Rename README to README.md

Since the CI will check mardkwon format files, the README files will
be updated to `.md` suffix.

Signed-off-by: George Liu <liuxiwei@ieisystem.com>
Change-Id: I6175f53024559b41e05c2bd91d76548c889cb3ca
1 file changed
tree: b311051737548aff2e4f55bfe806c87d39153f7b
  1. subprojects/
  2. .clang-format
  3. ipmb-channels.json
  4. ipmb.service
  5. ipmbbridged.cpp
  6. ipmbbridged.hpp
  7. ipmbdefines.hpp
  8. ipmbutils.cpp
  9. ipmbutils.hpp
  10. LICENSE
  11. meson.build
  12. OWNERS
  13. README.md
README.md

Sample config options available to configure :

  1. Single channel with one me and ipmb :
{
  "channels": [
    {
      "type": "me",
      "slave-path": "/dev/ipmb-4",
      "bmc-addr": 32,
      "remote-addr": 44
    },
    {
      "type": "ipmb",
      "slave-path": "/dev/ipmb-9",
      "bmc-addr": 32,
      "remote-addr": 96
    }
  ]
}
  1. Multiple sub channels with me and ipmb :
{
  "channels": [
    {
      "type": "me",
      "slave-path": "/dev/ipmb-1",
      "bmc-addr": 32,
      "remote-addr": 64,
      "devIndex": 0
    },
    {
      "type": "ipmb",
      "slave-path": "/dev/ipmb-3",
      "bmc-addr": 32,
      "remote-addr": 64,
      "devIndex": 0
    },
    {
      "type": "me",
      "slave-path": "/dev/ipmb-5",
      "bmc-addr": 32,
      "remote-addr": 64,
      "devIndex": 1
    },
    {
      "type": "ipmb",
      "slave-path": "/dev/ipmb-7",
      "bmc-addr": 32,
      "remote-addr": 64,
      "devIndex": 1
    }
  ]
}
Config fields :

type          : This points to the ChannelType. It can be ME or ipmb channel.
slave-path    : The ipmb device path.
bmc-addr      : This is BMC target address to communicate between BMC and device.
remote-addr   : This is Remote/requester target address to communicate between BMC and device.
devIndex      : This devIndex used to identify the particular device/host.