| commit | 4179012f16661a26e5b727905bef2273c22dcb39 | [log] [tgz] |
|---|---|---|
| author | Chris Frantz <cfrantz@google.com> | Tue Mar 10 13:03:30 2020 -0700 |
| committer | Eunchan Kim <me@eunchan.kim> | Tue Mar 10 14:13:46 2020 -0700 |
| tree | d5faa2da7e0d281f43cc876d90c05675a3b10c91 | |
| parent | 05ad5abd30d855547db1bed0fc33adfdf99c1aaa [diff] |
Correct a documentation error for the uart. The documentation has an example function which should either receive a character or return -1 if the receive fifo is empty. The documentation uses the type 'char' and the value '0xff' to represent -1, however the C standard does not define the signedness of char. Change to 'int', similar to the C standard library's 'getc' and friends, to conform the documented return value. It is also unclear what the C definition of 'UART_RDATA_REG' is, apart that it is a pointer itno the register space. The sample code in sw/device/lib/dif/dif_uart.c treats this register as a 32-bit register, so one assumes the sample code is meant to read this as a uint32 (however if it were declared as pointer-to-char, then a similar issue would exist with sign extension to the return type of int). Signed-off-by: Chris Frantz <cfrantz@google.com>
OpenTitan is an open source silicon Root of Trust (RoT) project. OpenTitan will make the silicon RoT design and implementation more transparent, trustworthy, and secure for enterprises, platform providers, and chip manufacturers. OpenTitan is administered by lowRISC CIC as a collaborative project to produce high quality, open IP for instantiation as a full-featured product. See the OpenTitan site and OpenTitan docs for more information about the project.
This repository contains hardware, software and utilities written as part of the OpenTitan project. It is structured as monolithic repository, or “monorepo”, where all components live in one repository. It exists to enable collaboration across partners participating in the OpenTitan project.
The project contains comprehensive documentation of all IPs and tools. You can either access it online or build it locally by following the steps below.
$ sudo apt install curl python3 python3-pip $ pip3 install --user -r python-requirements.txt
$ ./util/build_docs.py --preview
This compiles the documentation into ./build/docs and starts a local server, which allows you to access the documentation at http://127.0.0.1:1313.
Have a look at CONTRIBUTING for guidelines on how to contribute code to this repository.
Unless otherwise noted, everything in this repository is covered by the Apache License, Version 2.0 (see LICENSE for full text).