History log of /openbmc/docs/designs/ (Results 26 – 50 of 205)
Revision Date Author Comments
(<<< Hide modified files)
(Show modified files >>>)
5ef3526d05-Aug-2023 Jagpal Singh Gill <paligill@gmail.com>

code-update: add design doc for revision to code update

This design doc is a revision to existing code update flow.

Change-Id: I84a5ae4b6501126a8318541156aeebe8b110416c
Signed-off-by: Jagpal Singh

code-update: add design doc for revision to code update

This design doc is a revision to existing code update flow.

Change-Id: I84a5ae4b6501126a8318541156aeebe8b110416c
Signed-off-by: Jagpal Singh Gill <paligill@gmail.com>

show more ...

a8fff53a22-Dec-2023 Andrew Jeffery <andrew@codeconstruct.com.au>

OWNERS: Remove Andrew Jeffery from IBM OEM designs

Earlier this year I left IBM - I'll leave reviewing IBM's OEM designs
to Andrew G and Gunnar.

Change-Id: I7eab1cd4377489a2833fff94065d9b9310bd476c

OWNERS: Remove Andrew Jeffery from IBM OEM designs

Earlier this year I left IBM - I'll leave reviewing IBM's OEM designs
to Andrew G and Gunnar.

Change-Id: I7eab1cd4377489a2833fff94065d9b9310bd476c
Signed-off-by: Andrew Jeffery <andrew@codeconstruct.com.au>

show more ...

55c8509115-Dec-2023 Patrick Williams <patrick@stwcx.xyz>

bmc-health-monitor: unpluralize metrics in dbus interfaces

Align with typical dbus path and interface design and the latest
version of the dbus interfaces for Metric.Value.

Signed-off-by: Patrick W

bmc-health-monitor: unpluralize metrics in dbus interfaces

Align with typical dbus path and interface design and the latest
version of the dbus interfaces for Metric.Value.

Signed-off-by: Patrick Williams <patrick@stwcx.xyz>
Change-Id: I1b82d9019262feb8e3c9795aeae5760811e77be7

show more ...

d72704a502-Aug-2023 Lei YU <yulei.sh@bytedance.com>

design: Add SOL SysRq design doc

Add initial version of SOL SysRq design doc.

Signed-off-by: Lei YU <yulei.sh@bytedance.com>
Change-Id: I7c14de106a71585b11eed4a9a27e0fb677a3a954

60fea57c17-Oct-2023 Jagpal Singh Gill <paligill@gmail.com>

docs: phosphor-health-monitor: add timestamps

Add support for adding timestamps to indicate when specific metric was
collected. Existing EpochTime interface will be used for this purpose.

Change-Id

docs: phosphor-health-monitor: add timestamps

Add support for adding timestamps to indicate when specific metric was
collected. Existing EpochTime interface will be used for this purpose.

Change-Id: I9d58baa50ad6da5b1137490398092bf5344ea729
Signed-off-by: Jagpal Singh Gill <paligill@gmail.com>

show more ...

1937104912-Jul-2023 Jagpal Singh Gill <paligill@gmail.com>

docs: phosphor-health-monitor: design updates

This intent of this commit is to propose bunch of design updates for
phosphor-health-monitor. More specifically, a new D-Bus interface.

Change-Id: I298

docs: phosphor-health-monitor: design updates

This intent of this commit is to propose bunch of design updates for
phosphor-health-monitor. More specifically, a new D-Bus interface.

Change-Id: I298216136b8613accbcd3649f82cc8b657e00c50
Signed-off-by: Jagpal Singh Gill <paligill@gmail.com>

show more ...

d8e8237d29-Jun-2023 Gunnar Mills <gmills@us.ibm.com>

expired pw design: Switch to webui-vue

phosphor-webui has been replaced by webui-vue. Do so in this expired
password design as well.

Change-Id: I8f09b8e346259ae647ad69dfd904903770cba4fa
Signed-off-

expired pw design: Switch to webui-vue

phosphor-webui has been replaced by webui-vue. Do so in this expired
password design as well.

Change-Id: I8f09b8e346259ae647ad69dfd904903770cba4fa
Signed-off-by: Gunnar Mills <gmills@us.ibm.com>

show more ...

f44abd6626-Jan-2023 Ed Tanous <edtanous@google.com>

Add design doc about optionality

Many patches these days ignore the concept of features being optional,
and measuring impact to the project. This documentation attempts to
close that gap, by having

Add design doc about optionality

Many patches these days ignore the concept of features being optional,
and measuring impact to the project. This documentation attempts to
close that gap, by having some explicitly defined language in the
architecture that developers can reference in their commit messages, and
maintainers can point to for general guidance on option flags.

Signed-off-by: Ed Tanous <edtanous@google.com>
Change-Id: Id1ab8f1765110f58f22670db18db7ed226da6b57

show more ...

669d6fdd14-Feb-2023 Benjamin Fair <benjaminfair@google.com>

Update physical topology design

Change the names of the associations based on feedback from
phosphor-dbus-interfaces maintainers and the suffix on port types based
on feedback from entity-manager ma

Update physical topology design

Change the names of the associations based on feedback from
phosphor-dbus-interfaces maintainers and the suffix on port types based
on feedback from entity-manager maintainers.

Signed-off-by: Benjamin Fair <benjaminfair@google.com>
Change-Id: Icb4cd1710117b5b5782e9a8741a6b0c5d4740d9f

show more ...

649268a513-Feb-2023 Gunnar Mills <gmills@us.ibm.com>

power-recovery: Add Content-Type

From https://www.w3.org/Protocols/rfc2616/rfc2616-sec7.html#sec7.2.1:
Any HTTP/1.1 message containing an entity-body SHOULD include a
Content-Type header field defin

power-recovery: Add Content-Type

From https://www.w3.org/Protocols/rfc2616/rfc2616-sec7.html#sec7.2.1:
Any HTTP/1.1 message containing an entity-body SHOULD include a
Content-Type header field defining the media type of that body.

Redfish also mentions this "In HTTP messages, the media type is
specified in the Content-Type header."

bmcweb is attempting to validate content-type header,
https://gerrit.openbmc.org/c/openbmc/bmcweb/+/59941.

Change-Id: Ie020df1fd3b46ba1dad9720be5c8b384a77d7d7e
Signed-off-by: Gunnar Mills <gmills@us.ibm.com>

show more ...

f4febd0008-Dec-2022 Patrick Williams <patrick@stwcx.xyz>

prettier: re-format

Prettier is enabled in openbmc-build-scripts on Markdown, JSON, and YAML
files to have consistent formatting for these file types. Re-run the
formatter on the whole repository.

prettier: re-format

Prettier is enabled in openbmc-build-scripts on Markdown, JSON, and YAML
files to have consistent formatting for these file types. Re-run the
formatter on the whole repository.

Change-Id: I35ec9c19ae581e4dd00b515c1bba3a9c1862eeb1
Signed-off-by: Patrick Williams <patrick@stwcx.xyz>

show more ...


/openbmc/docs/CONTRIBUTING.md
/openbmc/docs/IPMITOOL-cheatsheet.md
/openbmc/docs/README.md
/openbmc/docs/REDFISH-cheatsheet.md
/openbmc/docs/REST-cheatsheet.md
/openbmc/docs/SECURITY.md
/openbmc/docs/anti-patterns.md
/openbmc/docs/architecture/LED-architecture.md
/openbmc/docs/architecture/code-update/code-update-deprecated.md
/openbmc/docs/architecture/code-update/code-update-diagrams.md
/openbmc/docs/architecture/code-update/code-update.md
/openbmc/docs/architecture/code-update/emmc-storage-design.md
/openbmc/docs/architecture/code-update/firmware-update-over-redfish.md
/openbmc/docs/architecture/code-update/flash-layout.md
/openbmc/docs/architecture/code-update/host-code-update.md
/openbmc/docs/architecture/interface-overview.md
/openbmc/docs/architecture/ipmi-architecture.md
/openbmc/docs/architecture/object-mapper.md
/openbmc/docs/architecture/openbmc-systemd.md
/openbmc/docs/architecture/redfish-logging-in-bmcweb.md
/openbmc/docs/architecture/sensor-architecture.md
/openbmc/docs/architecture/user-management.md
/openbmc/docs/cheatsheet.md
/openbmc/docs/code-of-conduct.md
/openbmc/docs/console.md
/openbmc/docs/cpp-style-and-conventions.md
README.md
binarystore-via-blobs.md
bios-bmc-smm-error-logging.md
bmc-boot-ready.md
bmc-health-monitor.md
bmc-reset-with-host-up.md
bmc-service-failure-debug-and-recovery.md
boot-progress.md
certificate-revocation-list.md
ci-authorization.md
design-template.md
device-tree-gpio-naming.md
dump-manager.md
ecc-dbus-sel.md
error-log-handling-for-phal.md
estoraged.md
expired-password.md
external-sensor.md
fail-boot-on-hw-error.md
firmware-update-via-blobs.md
firmware-update-via-usb.md
gpio-based-cable-presence.md
guard-on-bmc.md
hw-fault-monitor.md
management-console/Authorities_List_Management.md
management-console/VMI_Certificate_Exchange.md
management-console/service-discovery.md
mctp/mctp-kernel.md
mctp/mctp-userspace.md
mctp/mctp.md
multi-host-postcode.md
multihost-ipmi-design.md
multihost-phosphor-buttons.md
nmi-dbus-interface.md
nvmemi-over-smbus.md
oem/google/root_of_trust.md
oem/ibm/system-power-mode.md
phosphor-audit.md
phosphor-hwmon-io-uring.md
phosphor-hwmon-refactoring.md
physical-topology.md
pldm-stack.md
power-recovery.md
power-systems-memory-preserving-reboot.md
psu-firmware-update.md
psu-monitoring.md
redfish-authorization.md
redfish-eventservice.md
redfish-health-rolllup.md
redfish-pcie.md
redfish-postcodes.md
redfish-resource-supplement-for-pfr.md
redfish-tls-user-authentication.md
remote-bios-configuration.md
state-management-and-external-interfaces.md
target-fail-monitoring.md
telemetry.md
thermal-control-modes.md
unique-hostname.md
virtual-media.md
virtual-sensors.md
voltage-regulator-configuration.md
vpd-collection.md
/openbmc/docs/development/README.md
/openbmc/docs/development/add-new-system.md
/openbmc/docs/development/dev-environment.md
/openbmc/docs/development/gerrit-setup.md
/openbmc/docs/development/sdk-hello-world.md
/openbmc/docs/development/web-ui.md
/openbmc/docs/features.md
/openbmc/docs/glossary.md
/openbmc/docs/host-management.md
/openbmc/docs/kernel-development.md
/openbmc/docs/maintainer-workflow.md
/openbmc/docs/meta-layer-guidelines.md
/openbmc/docs/openbmc-conversion.md
/openbmc/docs/release/release-notes.md
/openbmc/docs/release/release-process.md
/openbmc/docs/rest-api.md
/openbmc/docs/security/TLS-configuration.md
/openbmc/docs/security/how-to-report-a-security-vulnerability.md
/openbmc/docs/security/network-security-considerations.md
/openbmc/docs/security/obmc-github-security-advisory-template.md
/openbmc/docs/security/obmc-security-response-team-guidelines.md
/openbmc/docs/security/obmc-security-response-team.md
/openbmc/docs/subtree.md
/openbmc/docs/testing/local-ci-build.md
/openbmc/docs/testing/run-test-docker.md
/openbmc/docs/tof/contract.md
/openbmc/docs/tof/membership-and-voting.md
/openbmc/docs/yocto-development.md
1adafbb331-Oct-2022 Nan Zhou <nanzhoumails@gmail.com>

redfish-dynamic-authz: fix minor issues

Fixed some grammar issues.

Signed-off-by: Nan Zhou <nanzhoumails@gmail.com>
Change-Id: Id4673a077fe1a7813142e46f54b2969722502b39

e87bd81d13-May-2022 Andrew Geissler <geissonator@yahoo.com>

bmc-boot-ready: ensure power on dependencies

IBM has seen a few occurrences where a power on and boot of a system is
requested before the needed BMC services have been started. The goal of
this desi

bmc-boot-ready: ensure power on dependencies

IBM has seen a few occurrences where a power on and boot of a system is
requested before the needed BMC services have been started. The goal of
this design is to provide a flexible solution to ensuring all needed BMC
services have started prior to allowing a power on and boot of a system.

Change-Id: Icbc1268903204f0417b2962c3b4c37c57eb4d208
Signed-off-by: Andrew Geissler <geissonator@yahoo.com>

show more ...

93f86ae213-Sep-2022 Brandon Kim <brandonkim@google.com>

designs: bios-bmc-smm-error-logging: Update Description

It seems Queue Size description was ambiguous. Update the definition so
that it is clearer.

Signed-off-by: Brandon Kim <brandonkim@google.com

designs: bios-bmc-smm-error-logging: Update Description

It seems Queue Size description was ambiguous. Update the definition so
that it is clearer.

Signed-off-by: Brandon Kim <brandonkim@google.com>
Change-Id: I708b5567c8e7d2f216dbe37765cd7387b46b4513

show more ...

36aae45b19-Sep-2022 Andrew Geissler <geissonator@yahoo.com>

add maintainers to ibm oem designs

The IBM team has begun working on their next system design which entails
a few IBM-specific functions. These will be stored under the
designs/oem/ibm/ sub-director

add maintainers to ibm oem designs

The IBM team has begun working on their next system design which entails
a few IBM-specific functions. These will be stored under the
designs/oem/ibm/ sub-directory. The hope is that by making these designs
public, there will be potential for collaboration in the future with
other companies that have similar requirements.

Add AndrewJ, AndrewG, and Gunnar as maintainers of these docs from IBM.

Change-Id: I855795d76229293e071f76084f174ca834e1009d
Signed-off-by: Andrew Geissler <geissonator@yahoo.com>

show more ...

8fd98f1309-Aug-2022 Nan Zhou <nanzhoumails@gmail.com>

design: dynamic redfish authz

This commit proposes a design to implement a dynamic authorization
system for the Redfish interface, so that system managers can update
authorization behaviors without

design: dynamic redfish authz

This commit proposes a design to implement a dynamic authorization
system for the Redfish interface, so that system managers can update
authorization behaviors without recompile and even service reset.

Signed-off-by: Nan Zhou <nanzhoumails@gmail.com>
Change-Id: Icc6dadc1ad3230e34c7525a8b08efb6f7da52262

show more ...

e12059ab01-Jun-2022 Benjamin Fair <benjaminfair@google.com>

Physical topology design

This design describes a way to encode information about the physical
topology of a system such as one chassis containing another or being
powered by a power supply. It also

Physical topology design

This design describes a way to encode information about the physical
topology of a system such as one chassis containing another or being
powered by a power supply. It also explains how this information will be
consumed by daemons such as bmcweb to represent it in Redfish.

Signed-off-by: Benjamin Fair <benjaminfair@google.com>
Change-Id: If0c0193b6bc2eae79d82756462d23ef7084f9fc1

show more ...

503fbd3409-Sep-2022 Brandon Kim <brandonkim@google.com>

designs: bios-bmc-smm-error-logging: Change header

During this review:
https://gerrit.openbmc.org/c/openbmc/docs/+/52109

We noted that we should increase the queueSize header to increase the
bigger

designs: bios-bmc-smm-error-logging: Change header

During this review:
https://gerrit.openbmc.org/c/openbmc/docs/+/52109

We noted that we should increase the queueSize header to increase the
bigger supported queue size. The BIOS team and the BMC team
implementing this decided that 3 byte size gave enough size increase to
the queue size (up to 16MB) and gave us more padding / reserved bytes in
the header for future flexibility instead of increasing to 4 bytes.

As we are lacking README.md for the repo, update the design doc so that
this header is matching the code.

Signed-off-by: Brandon Kim <brandonkim@google.com>
Change-Id: Ifecfc64148e63f8f727e8f3c732bca7e17d31b87

show more ...

33bd07ba08-Sep-2022 Patrick Williams <patrick@stwcx.xyz>

oem: move ibm subdirectory into oem tree

Signed-off-by: Patrick Williams <patrick@stwcx.xyz>
Change-Id: I983773d91af2807faa60a47a3ebc61b34dcb1f73

33940c0302-Sep-2022 Nan Zhou <nanzhoumails@gmail.com>

mctp-userspace: wrap at 79

This is aligned with the design template. Done by vim gq.

Signed-off-by: Nan Zhou <nanzhoumails@gmail.com>
Change-Id: I1b4f7408f24776e88f6b5e6b1d1b525e9a32f249

5d52507e02-Sep-2022 Nan Zhou <nanzhoumails@gmail.com>

mctp: fix a hyperlink

The original syntax is wrong. It should be [DisplayText](link).

Signed-off-by: Nan Zhou <nanzhoumails@gmail.com>
Change-Id: Ice0304b29785de3efa09497a63de0d3cb91ec3da

0b7780b517-Mar-2022 Brandon Kim <brandonkim@google.com>

design: Add bios-bmc-smm-error-logging.md

This design doc is for providing a shared buffer between the BMC and the
BIOS that allows the BIOS to send a very fast message without requiring
an ack from

design: Add bios-bmc-smm-error-logging.md

This design doc is for providing a shared buffer between the BMC and the
BIOS that allows the BIOS to send a very fast message without requiring
an ack from the BMC within SMM.

Signed-off-by: Brandon Kim <brandonkim@google.com>
Change-Id: Id76029a9f5c869a5e2a77fd53843c926b438b67d

show more ...

9db762d824-Jul-2022 Andrew Jeffery <andrew@aj.id.au>

design-template: Design proposals are argumentative essays.

State this explicitly in the guidelines. The Grammarly blog post is
excellent and well worth the read.

Change-Id: I06ef86fab5601e3ad0e8b5

design-template: Design proposals are argumentative essays.

State this explicitly in the guidelines. The Grammarly blog post is
excellent and well worth the read.

Change-Id: I06ef86fab5601e3ad0e8b5b2fefd85aec25a6015
Signed-off-by: Andrew Jeffery <andrew@aj.id.au>

show more ...

33b2529524-Jul-2022 Andrew Jeffery <andrew@aj.id.au>

design-template: Organise guidelines

Add some sub-headers and rename the section to "Document Guidelines".
Do the rename because the section is guiding you on when/how to write
the document, not how

design-template: Organise guidelines

Add some sub-headers and rename the section to "Document Guidelines".
Do the rename because the section is guiding you on when/how to write
the document, not how to design your thingo.

Change-Id: Iddf5540e80d5af00c9ef49bd1f7077cd4dfdddaa
Signed-off-by: Andrew Jeffery <andrew@aj.id.au>

show more ...

e2430b1523-Jul-2022 Ed Tanous <edtanous@google.com>

Update organizational section with maintainer cc

Lots of designs get submitted that seem to omit the maintainers from the
CC list, as well as designs that focus on only one part of the design
(somet

Update organizational section with maintainer cc

Lots of designs get submitted that seem to omit the maintainers from the
CC list, as well as designs that focus on only one part of the design
(sometimes dbus, sometimes redfish, sometimes IPMI) without considering
the whole system.

This commit adds a section to the design template for "repos that are
expected to be modified", so that we can make sure the required
reviewers are present on the design. This also helps as a hint to
reviewers that they need to account for their whole design
(hw->dbus->user interface), not just a single piece, like dbus->user
interface or hw->dbus.

Signed-off-by: Ed Tanous <edtanous@google.com>
Change-Id: I74d34dafe7da0c83484df7afa96d3aef12efcc27

show more ...

123456789