summaryrefslogtreecommitdiffstats
Commit message (Collapse)AuthorAgeFilesLines
* designs: Add MCTP design documentJeremy Kerr2019-03-212-0/+752
| | | | | | | | | | | | | Add initial design document, as posted on the openbmc list, and incorporating feedback from: - Emily Shaffer <emilyshaffer@google.com> - Nilan Naidoo <nilan.naidoo@intel.com> - Supreeth Venkatesh <supreeth.venkatesh@arm.com> - Ed Tanous <ed.tanous@intel.com> Change-Id: I9731b2ca9752bdf826e0e98486cfbc3393336043 Signed-off-by: Jeremy Kerr <jk@ozlabs.org>
* cheatsheet: Add more develop tipsLei YU2019-03-201-0/+166
| | | | | | | Add more tips about building, developing and testing OpenBMC. Change-Id: I37ea9e8fc2072c6a15d767d8684d5cc6637e466e Signed-off-by: Lei YU <mine260309@gmail.com>
* cheatsheet: Add ulimit for coredumpLei YU2019-03-201-0/+1
| | | | | | | | Add `ulimit -c unlimited` to generate coredump, otherwsie the default coredump limit is 0 and it will not be generated. Change-Id: I3ca8a4ebc3e9cf6fbf1e45e9077315affb9adaa9 Signed-off-by: Lei YU <mine260309@gmail.com>
* add-new-system: Add detailed configurationsLei YU2019-03-201-7/+551
| | | | | | | | Add detailed description about configurations for various components (e.g. sensors, LEDs, GPIOs, etc) with examples. Change-Id: Id606e4bac00ddb8fd8773beffb30296a910be8c0 Signed-off-by: Lei YU <mine260309@gmail.com>
* designs: Firmware update over RedfishAndrew Geissler2019-03-191-0/+156
| | | | | | | Requirements and design proposal for firmware update over Redfish Change-Id: Ie7401ee2d655700cc04f6c437a4c4804220f4ebc Signed-off-by: Andrew Geissler <geissonator@yahoo.com>
* anti-patterns: use cli11 instead of custom parserPatrick Venture2019-03-181-0/+26
| | | | | | | | | | Many OpenBMC applications have a custom ArgumentParser object to provide a modern argument parsing interface. These are nearly identical between daemons. The CLI11 library provides a modern argument parsing interface with advanced validation. Change-Id: I11ca97b2990e342c203ec54b9f3d40bbcebb55eb Signed-off-by: Patrick Venture <venture@google.com>
* Added default port example for QEMUMaksym2019-03-181-0/+7
| | | | | | | | | Alternate variant in "Start QEMU" section is added. Used by Jenkins and/or openbmc-test-automation Change-Id: I40a7dbd12c55b5550cfbe78b3f6165d251d18d34 Signed-off-by: Maksym Yepaneshnikov <maxim.yep@gmail.com> Signed-off-by: Brad Bishop <bradleyb@fuzziesquirrel.com>
* development: Add gerrit-setup.md to READMEAnthony Wilson2019-03-131-0/+5
| | | | | Change-Id: Iafdabf0da1bb04a5ecfe0bbc5bbcbf08b8fdc114 Signed-off-by: Anthony Wilson <wilsonan@us.ibm.com>
* Docs: Add Feature list with links to docsJoseph Reynolds2019-03-072-0/+71
| | | | | | | | | | This creates a document which lists OpenBMC features and provides links to documentation about each feature. Tested: via copy/paste into: https://dillinger.io Change-Id: Idfcd311a8b2fe4e30505a851e2aa77e26d5f442a Signed-off-by: Joseph Reynolds <jrey@us.ibm.com>
* design: Add "design" topic to gerrit reviewsAndrew Geissler2019-02-231-0/+2
| | | | | | | | | | This allows a query like this to be run to find all open design docs: https://gerrit.openbmc-project.xyz/#/q/topic:design+status:open This allows easy searching for design reviews in gerrit. Change-Id: Ia9dbdf0b762af7713e2cbd647ca45a8c5a609424 Signed-off-by: Andrew Geissler <geissonator@yahoo.com>
* anti-patterns: application install in /usr/sbinBrad Bishop2019-02-201-0/+35
| | | | | | | | | | | Many OpenBMC applications install targets incorrectly place applications in /usr/sbin/ Tested: Copied into https://jbt.github.io/markdown-editor/ and app.grammarly.com. Change-Id: Ia18021b68ad2392b3fa5c860af36dba25210ee4b Signed-off-by: Brad Bishop <bradleyb@fuzziesquirrel.com> Signed-off-by: Gunnar Mills <gmills@us.ibm.com>
* thermal_control_modes: Add newlinesGunnar Mills2019-02-181-0/+3
| | | | | | | | | | Author, Primary assignee, Other contributors, and Created are easier to read if they are on separate lines. Tested: Copied into https://jbt.github.io/markdown-editor/ Change-Id: If6454d2c27a615bacfcf354e6c278345978f09e2 Signed-off-by: Gunnar Mills <gmills@us.ibm.com>
* designs: Thermal Control Mode interfaceMatthew Barth2019-02-181-0/+78
| | | | | | | | | | | New dbus interface proposal for thermal control applications to use in providing an end-user the ability to change the mode in which the application controls the thermal parameters of a platform. Each platform would provide the supported modes available in its configuration of the thermal control application it uses. Change-Id: I18a0f005c1d278a16d0af6b35e97bb6dcc35e8c7 Signed-off-by: Matthew Barth <msbarth@us.ibm.com>
* Add in host watchdog sectionAndrew Geissler2019-02-161-0/+41
| | | | | | | | The host watchdog function has a lot of moving parts so wanted to get them all down in one spot Change-Id: Ie2f20ab9e1459ee8e21c2397a87bb14bbecf5783 Signed-off-by: Andrew Geissler <geissonator@yahoo.com>
* Fix up LED-Architecture.mdGunnar Mills2019-02-141-40/+36
| | | | | | | | | | | | Fixed some grammar, spelling, and punctuation. Fixed links to reflect a newer kernel and the updated subtrees layers. Changed wording to be consistent. Removed a 3rd link to the LED D-Bus README. Tested: Copied into https://jbt.github.io/markdown-editor/ Change-Id: I66208553ea64458da1e1e0fad97e60aa5efe8d4f Signed-off-by: Gunnar Mills <gmills@us.ibm.com>
* anti-patterns: explicit missing pkg messagesPatrick Venture2019-02-131-0/+31
| | | | | | | | | | | Nearly all OpenBMC packages rely primarily on other OpenBMC packages to build and link. Therefore, it's generally sufficient to list the missing package via the default missing package behavior. In the event the package name isn't the same as the library expected, then overwriting the error message is still helpful. Change-Id: I9fc6eba07e09480f9e1da8662d202be681c7506e Signed-off-by: Patrick Venture <venture@google.com>
* maintainer-workflow: Remove tabsGunnar Mills2019-02-131-6/+6
| | | | | | | | No other docs/ have tabs, they are not needed. Tested: Copied into https://jbt.github.io/markdown-editor/ Change-Id: If61ee55ec116ed8bacaa2dbb09023498c7f3cfcd Signed-off-by: Gunnar Mills <gmills@us.ibm.com>
* maintainer-workflow: Fix linksGunnar Mills2019-02-131-7/+9
| | | | | | Tested: Copied into https://jbt.github.io/markdown-editor/ Change-Id: I8e78f322af3e2ba7519977b3b2c7e46dc9809a32 Signed-off-by: Gunnar Mills <gmills@us.ibm.com>
* Move release docs to release/ dirGunnar Mills2019-02-122-1/+1
| | | | | | | | | | Created a release/ dir and moved release docs to it. Renamed release docs with a - (this is the convention used in the other docs). Fixed the link release-notes.md Change-Id: I565ccb38f55dbdc4fcf84a743bd7928c826dda30 Signed-off-by: Gunnar Mills <gmills@us.ibm.com>
* anti-patterns: add /usr/bin/env launchingBrad Bishop2019-02-121-0/+57
| | | | | | | | Outside of OpenBMC, most applications that provide systemd unit files don't launch applications in this way. Change-Id: Ie918be8727c51a1f8f05b8f845b9967c2a18c5af Signed-off-by: Brad Bishop <bradleyb@fuzziesquirrel.com>
* anti-patterns: explicit shared lib dependenciesBrad Bishop2019-02-121-0/+31
| | | | | | | | | | Out of the box bitbake examines built applications, automatically adds runtime dependencies and thus ensures any library packages dependencies are automatically added to images, sdks, etc. There is no need to list them explicitly in a recipe. Change-Id: Ia19805546eb5808afebbc757e4ca36c562109075 Signed-off-by: Brad Bishop <bradleyb@fuzziesquirrel.com>
* security-response-team: Capitalize GerritGunnar Mills2019-02-111-1/+1
| | | | | Change-Id: I30cb36b2d61f0e57cffeaebaca48623e9b1ba56d Signed-off-by: Gunnar Mills <gmills@us.ibm.com>
* Fix GitHub capitalizationGunnar Mills2019-02-112-2/+2
| | | | | Change-Id: I5b3cbbb3e49b0f1c76bd24f40dfe0f650f527f65 Signed-off-by: Gunnar Mills <gmills@us.ibm.com>
* Spelling fixesGunnar Mills2019-02-113-3/+3
| | | | | | | | These spelling errors were found using https://github.com/codespell-project/codespell Change-Id: I6da6ccf791768734149cd3a6c005e46736dd9618 Signed-off-by: Gunnar Mills <gmills@us.ibm.com>
* ci-authorization: Add newlinesGunnar Mills2019-02-111-0/+3
| | | | | | | | | Author, Primary assignee, Other contributors, and Created are easier to read if they are on separate lines. Tested: Copied into https://jbt.github.io/markdown-editor/ Change-Id: Ie9a97e654984da3ffb1d5dbb88f7a93ada4a942d Signed-off-by: Gunnar Mills <gmills@us.ibm.com>
* Put Author, Assignee, Created on newlineGunnar Mills2019-02-111-0/+3
| | | | | | | | | These header fields are easier to read if they are on separate lines. Tested: Copied into https://jbt.github.io/markdown-editor Change-Id: Ibcd204f21d40c99ccce14cc97947c212ccc337b5 Signed-off-by: Gunnar Mills <gmills@us.ibm.com>
* OpenBMC Release NotesKurt Taylor2019-02-111-0/+232
| | | | | | | | | This file will contain release notes for project releases. Please only review the current 2.6 release. The prior notes are listed for completeness from the openbmc/openbmc release tags. Change-Id: I936aeed15dda6bccf982f672aaee7847e74b74b8 Signed-off-by: Kurt Taylor <kurt.r.taylor@gmail.com>
* Add newlinesDeepak Kodihalli2019-02-091-0/+2
| | | | | | | Add missing newlines to pldm-stack.md. Change-Id: I9e19ba3e35fabd5df4c3fbac97ba8351c6f81696 Signed-off-by: Deepak Kodihalli <dkodihal@in.ibm.com>
* add anti-paterrns for code reviewBrad Bishop2019-02-081-0/+43
| | | | | | | | | | | | | | | The developers of OpenBMC do not get 100% of decisions right 100% of the time. That, combined with the fact that software development is often an exercise in copying and pasting, results in mistakes happening over and over again. Add a page that aims to document some of the anti-patterns that exist in OpenBMC to ease the job of those reviewing code. If an anti-pattern is spotted, rather that repeating the same explanations over and over, a link to this document can be provided. Change-Id: Ie5efc1ef61a0b948330fa576eca09d5b6fa64751 Signed-off-by: Brad Bishop <bradleyb@fuzziesquirrel.com>
* designs: Jenkins CI authorizationBrad Bishop2019-02-081-0/+105
| | | | | | | | An attempt to streamline maintainence of the Jenkins CI authorization ACL. Change-Id: I380a4fbb769ae4af39b6cd17b59703dcebff7ba9 Signed-off-by: Brad Bishop <bradleyb@fuzziesquirrel.com>
* design: Add binarystore_via_blobsKun Yi2019-02-061-0/+213
| | | | | | | | | Add a design proposal draft for implementing a generic method to store simple, short binary blobs to BMC persistent storage through IPMI blob transfer mechanisms. Change-Id: I649c0598d611e49b599971b7c048165011d62d2a Signed-off-by: Kun Yi <kunyi731@gmail.com>
* Add design for a PLDM stackDeepak Kodihalli2019-02-051-0/+241
| | | | | | | | | | | | | | | | | | | Propose a design for implementing DMTF's Platform Level Data Model (PLDM) specifications. The idea is to employ PLDM for various "inside the box" communication scenarios, such as Host<->BMC, BMC<->Sensor device, BMC<->IO device, BMC<->BMC, etc. The design was first proposed on the OpenBMC mailing list: https://lists.ozlabs.org/pipermail/openbmc/2018-December/014356.html. Feedback received has been incorporated into this commit, and the plan is to continue further reviews on Gerrit. This commit describes, apart from the background and requirements, the design for elements such as the PLDM requester, PLDM responder, protocol handling, and platform specific actions. Change-Id: I8eb17e206a510f852d6035c5a15184646eeb540b Signed-off-by: Deepak Kodihalli <dkodihal@in.ibm.com>
* Update rest-api.md for bmcwebMatt Spinler2019-02-011-38/+24
| | | | | | | | Point at REST-cheatsheet.md for details on how to authenticate. Remove the now unecessary cjar and ContentType arguments. Change-Id: I0b6024e98719dd610e0d85d6d05067c0aa0c21ec Signed-off-by: Matt Spinler <spinler@us.ibm.com>
* Update REST doc for bmcweb authenticationMatt Spinler2019-01-281-1/+64
| | | | | | | | | The bmcweb REST server requires passing in either the user name and password or the authentication token on the REST operations that can do modifications. Change-Id: Ibac6f6b4f4f7c504dda4f8a364b071e4b1970458 Signed-off-by: Matt Spinler <spinler@us.ibm.com>
* REST-cheatsheet: Remove unnecessary write to cjarGunnar Mills2019-01-281-37/+37
| | | | | | | | | | | | | | | | | | "-c, --cookie-jar <filename> (HTTP) Specify to which file you want curl to write all cookies after a completed operation. Curl writes all cookies from its in-memory cookie storage to the given file at the end of operations. If no cookies are known, no data will be written." Only login and logout write to the cookie file. Removed to not confuse people, also makes the commands shorter and easier to read. Tested: Issued curl commands like "Host power on" and enumerate software. Change-Id: I2b9a494758014edd5ca0c4173db6eaec78e7c1ae Signed-off-by: Gunnar Mills <gmills@us.ibm.com>
* designs: firmware_update_via_blobs: add configuration detailsPatrick Venture2019-01-251-0/+56
| | | | | | | | | Add the details on how one has to configure a platform to use it. Although these details are less about the design, they are becoming relevant. Change-Id: I11ee48dc768aa424fe6fb5886e030ee172a5c8de Signed-off-by: Patrick Venture <venture@google.com>
* sensor-architecture: Add a blurb for sensor configurationKun Yi2019-01-241-0/+54
| | | | | | | | | Add a short section on example of sensor configuration and how to choose the coefficients. A little deep-dive into how IPMI spec defines sensor reading calculations. Signed-off-by: Kun Yi <kunyi731@gmail.com> Change-Id: Id810dfbaf1e6bfce217d68465f088de1074784c4
* meetings: Reduce severity of headerAndrew Jeffery2019-01-161-1/+1
| | | | | | | | I know caps-lock is cruise control for cool, but I think standard capitalisation reads better. Change-Id: If6aeb6da4280bab60c9baf79c0b8a7281ca3d6e7 Signed-off-by: Andrew Jeffery <andrew@aj.id.au>
* meetings: Add code markdown where appropriate in README.mdAndrew Jeffery2019-01-161-8/+11
| | | | | Change-Id: I5183074d5d646d3022e2d713b19d77c7c72a2e2f Signed-off-by: Andrew Jeffery <andrew@aj.id.au>
* meetings: mv README{,.md} to enable github markdown renderingAndrew Jeffery2019-01-161-0/+0
| | | | | Change-Id: Ic756f5ab16eb6ecbc1e0d73544fe3324fc3a3bc9 Signed-off-by: Andrew Jeffery <andrew@aj.id.au>
* gerrit-setup: Add section on pushing to GerritAnthony Wilson2019-01-071-2/+22
| | | | | | | | | While not directly associated with the setup of Gerrit, this will give a new user an end to end idea of the Gerrit code review workflow. Change-Id: If0194939bd5205d8af129d53b59f40e396f1eeda Signed-off-by: Anthony Wilson <wilsonan@us.ibm.com>
* Make "Host Clear GARD" section consistent sizeAndrew Geissler2018-12-101-1/+1
| | | | | Change-Id: I7bc9dca5e3d5d481978d98a217c7c96f98c67ec3 Signed-off-by: Andrew Geissler <geissonator@yahoo.com>
* Ensure text does not exceed 80 charsAndrew Geissler2018-12-101-9/+13
| | | | | Change-Id: I2dc35db00ec50f6efe083a249a1b76e1892c390a Signed-off-by: Andrew Geissler <geissonator@yahoo.com>
* Add Gerrit setup documentationAnthony Wilson2018-12-031-0/+73
| | | | | | | | Guide for new users to setup their workstations to connect to and utilize Gerrit. Change-Id: Id0d263b4c775d0a26378d517047b0feea3c96d9e Signed-off-by: Anthony Wilson <wilsonan@us.ibm.com>
* Create an OpenBMC GlossaryJoseph Reynolds2018-12-011-0/+42
| | | | | | | | | | | | Provide a list of terminology and acronyms used in the OpenBMC project together with definitions and explanations as a training aid to community members who need to know the meaning of terms which are not easily found or disambiguated. Tested: N/A Change-Id: I0cd346fe6164037f46abd12a21b4c7150cc34559 Signed-off-by: Joseph Reynolds <jrey@us.ibm.com>
* dev-environment: Fix example formattingAlexander Amelkin2018-11-261-6/+7
| | | | | | | | Use proper markdown with `obmcutil state` example, also fix 'Note' formatting under that example. Change-Id: I45dcaf282d422f6ab8a91e554ef75f6bcbb6633f Signed-off-by: Alexander Amelkin <a.amelkin@yadro.com>
* designs: firmware_update: simplify verificationPatrick Venture2018-11-251-15/+36
| | | | | | | | | | | | Simply the verification approach by providing an additional blob_id whose purpose is to handle triggering verification as well as reporting verification status. Originally, this was handled by actions against the hash blob, however this lead to unnecessary complexity. Change-Id: Ic63900340abae0dac3453619b6cf1c90b8124504 Signed-off-by: Patrick Venture <venture@google.com>
* Add obmc-host-shutdown target dependenciesAndrew Geissler2018-11-201-0/+75
| | | | | | | | | | | | | | | The following information was needed to debug an issue in the power down path. Since the data was useful, makes sense to keep in the corresponding doc. This new section shows all of the targets and services associated with powering off a system and their dependencies. It's for a witherspoon system but the targets and some services are relevant to other systems as well. Change-Id: I62ae04814765f20013de15ec0430a4a94bc5f2bf Signed-off-by: Andrew Geissler <geissonator@yahoo.com>
* designs: firmware_update: add detailsPatrick Venture2018-11-161-4/+23
| | | | | | | Add details pertaining to the P2A bridge configuration. Change-Id: I69d1c95fbfbba84cadfaea9c8a89f8416c14d469 Signed-off-by: Patrick Venture <venture@google.com>
* Add first version of community Code of ConductEmily Shaffer2018-11-151-0/+209
| | | | | | | Adapted from the Linux Foundation COC, https://lfprojects.org/policies/code-of-conduct/ Change-Id: Ic5251970b65ab46b6c5a979e14fbcfa24772be4f Signed-off-by: Emily Shaffer <emilyshaffer@google.com>
OpenPOWER on IntegriCloud