From: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
To: unlisted-recipients:; (no To-header on input)
Cc: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>,
Jonathan Corbet <corbet@lwn.net>,
linux-doc@vger.kernel.org
Subject: [PATCH v3 09/18] docs: misc-devices/c2port.txt: convert to ReST format
Date: Tue, 3 Mar 2020 14:59:16 +0100 [thread overview]
Message-ID: <e16e19ff9332ac58311abe743688f83508d5cd0e.1583243826.git.mchehab+huawei@kernel.org> (raw)
In-Reply-To: <cover.1583243826.git.mchehab+huawei@kernel.org>
- Use copyright symbol;
- use title markups;
- adjust indentation;
- mark literal blocks as such.
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
---
.../misc-devices/{c2port.txt => c2port.rst} | 58 ++++++++++---------
Documentation/misc-devices/index.rst | 1 +
2 files changed, 32 insertions(+), 27 deletions(-)
rename Documentation/misc-devices/{c2port.txt => c2port.rst} (59%)
diff --git a/Documentation/misc-devices/c2port.txt b/Documentation/misc-devices/c2port.rst
similarity index 59%
rename from Documentation/misc-devices/c2port.txt
rename to Documentation/misc-devices/c2port.rst
index ea7344465610..258e1c1d43c7 100644
--- a/Documentation/misc-devices/c2port.txt
+++ b/Documentation/misc-devices/c2port.rst
@@ -1,7 +1,11 @@
- C2 port support
- ---------------
+.. SPDX-License-Identifier: GPL-2.0
+.. include:: <isonum.txt>
-(C) Copyright 2007 Rodolfo Giometti <giometti@enneenne.com>
+===============
+C2 port support
+===============
+
+|copy| Copyright 2007 Rodolfo Giometti <giometti@enneenne.com>
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
@@ -32,10 +36,10 @@ The C2 Interface main references are at (http://www.silabs.com)
Silicon Laboratories site], see:
- AN127: FLASH Programming via the C2 Interface at
-http://www.silabs.com/Support Documents/TechnicalDocs/an127.pdf
+ http://www.silabs.com/Support Documents/TechnicalDocs/an127.pdf
- C2 Specification at
-http://www.silabs.com/pages/DownloadDoc.aspx?FILEURL=Support%20Documents/TechnicalDocs/an127.pdf&src=SearchResults
+ http://www.silabs.com/pages/DownloadDoc.aspx?FILEURL=Support%20Documents/TechnicalDocs/an127.pdf&src=SearchResults
however it implements a two wire serial communication protocol (bit
banging) designed to enable in-system programming, debugging, and
@@ -47,44 +51,44 @@ Using the driver
----------------
Once the driver is loaded you can use sysfs support to get C2port's
-info or read/write in-system flash.
+info or read/write in-system flash::
-# ls /sys/class/c2port/c2port0/
-access flash_block_size flash_erase rev_id
-dev_id flash_blocks_num flash_size subsystem/
-flash_access flash_data reset uevent
+ # ls /sys/class/c2port/c2port0/
+ access flash_block_size flash_erase rev_id
+ dev_id flash_blocks_num flash_size subsystem/
+ flash_access flash_data reset uevent
Initially the C2port access is disabled since you hardware may have
such lines multiplexed with other devices so, to get access to the
-C2port, you need the command:
+C2port, you need the command::
-# echo 1 > /sys/class/c2port/c2port0/access
+ # echo 1 > /sys/class/c2port/c2port0/access
after that you should read the device ID and revision ID of the
-connected micro controller:
+connected micro controller::
-# cat /sys/class/c2port/c2port0/dev_id
-8
-# cat /sys/class/c2port/c2port0/rev_id
-1
+ # cat /sys/class/c2port/c2port0/dev_id
+ 8
+ # cat /sys/class/c2port/c2port0/rev_id
+ 1
However, for security reasons, the in-system flash access in not
-enabled yet, to do so you need the command:
+enabled yet, to do so you need the command::
-# echo 1 > /sys/class/c2port/c2port0/flash_access
+ # echo 1 > /sys/class/c2port/c2port0/flash_access
-After that you can read the whole flash:
+After that you can read the whole flash::
-# cat /sys/class/c2port/c2port0/flash_data > image
+ # cat /sys/class/c2port/c2port0/flash_data > image
-erase it:
+erase it::
-# echo 1 > /sys/class/c2port/c2port0/flash_erase
+ # echo 1 > /sys/class/c2port/c2port0/flash_erase
-and write it:
+and write it::
-# cat image > /sys/class/c2port/c2port0/flash_data
+ # cat image > /sys/class/c2port/c2port0/flash_data
-after writing you have to reset the device to execute the new code:
+after writing you have to reset the device to execute the new code::
-# echo 1 > /sys/class/c2port/c2port0/reset
+ # echo 1 > /sys/class/c2port/c2port0/reset
diff --git a/Documentation/misc-devices/index.rst b/Documentation/misc-devices/index.rst
index 04f5dab2384c..c2e880d78734 100644
--- a/Documentation/misc-devices/index.rst
+++ b/Documentation/misc-devices/index.rst
@@ -16,6 +16,7 @@ fit into other categories.
ad525x_dpot
eeprom
+ c2port
ibmvmc
ics932s401
isl29003
--
2.24.1
next prev parent reply other threads:[~2020-03-03 13:59 UTC|newest]
Thread overview: 29+ messages / expand[flat|nested] mbox.gz Atom feed top
[not found] <cover.1583243826.git.mchehab+huawei@kernel.org>
2020-03-03 13:59 ` [PATCH v3 01/18] docs: thermal: convert cpu-idle-cooling.rst to ReST Mauro Carvalho Chehab
2020-03-03 13:59 ` [PATCH v3 02/18] docs: crypto: convert asymmetric-keys.txt " Mauro Carvalho Chehab
2020-03-03 13:59 ` Mauro Carvalho Chehab
2020-03-03 20:09 ` Jarkko Sakkinen
2020-03-03 20:09 ` Jarkko Sakkinen
2020-03-03 13:59 ` [PATCH v3 03/18] docs: crypto: convert api-intro.txt to ReST format Mauro Carvalho Chehab
2020-03-03 13:59 ` [PATCH v3 04/18] docs: crypto: convert async-tx-api.txt " Mauro Carvalho Chehab
2020-03-06 13:38 ` Vinod Koul
2020-03-03 13:59 ` [PATCH v3 05/18] docs: crypto: descore-readme.txt: convert " Mauro Carvalho Chehab
2020-03-03 13:59 ` [PATCH v3 06/18] docs: misc-devices/spear-pcie-gadget.txt: convert to ReST Mauro Carvalho Chehab
2020-03-03 13:59 ` [PATCH v3 07/18] docs: misc-devices/pci-endpoint-test.txt: " Mauro Carvalho Chehab
2020-03-03 13:59 ` [PATCH v3 08/18] " Mauro Carvalho Chehab
2020-03-03 13:59 ` Mauro Carvalho Chehab [this message]
2020-03-03 13:59 ` [PATCH v3 10/18] docs: misc-devices/bh1770glc.txt: " Mauro Carvalho Chehab
2020-03-03 13:59 ` [PATCH v3 11/18] docs: misc-devices/apds990x.txt: convert to ReST format Mauro Carvalho Chehab
2020-03-03 13:59 ` [PATCH v3 12/18] docs: pci: endpoint/function/binding/pci-test.txt convert to ReST Mauro Carvalho Chehab
2020-03-03 13:59 ` [PATCH v3 13/18] docs: arm64: convert perf.txt to ReST format Mauro Carvalho Chehab
2020-03-03 13:59 ` Mauro Carvalho Chehab
2020-03-03 13:59 ` [PATCH v3 14/18] docs: powerpc: convert vcpudispatch_stats.txt to ReST Mauro Carvalho Chehab
2020-03-03 13:59 ` Mauro Carvalho Chehab
2020-03-04 0:17 ` Michael Ellerman
2020-03-04 0:17 ` Michael Ellerman
2020-03-03 13:59 ` [PATCH v3 15/18] docs: sh: convert new-machine.txt " Mauro Carvalho Chehab
2020-03-03 13:59 ` Mauro Carvalho Chehab
2020-03-03 13:59 ` [PATCH v3 16/18] docs: sh: convert register-banks.txt " Mauro Carvalho Chehab
2020-03-03 13:59 ` Mauro Carvalho Chehab
2020-03-03 13:59 ` [PATCH v3 17/18] docs: trace: ring-buffer-design.txt: convert to ReST format Mauro Carvalho Chehab
2020-03-03 13:59 ` [PATCH v3 18/18] docs: kvm: get read of devices/README Mauro Carvalho Chehab
2020-03-03 14:03 ` Paolo Bonzini
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=e16e19ff9332ac58311abe743688f83508d5cd0e.1583243826.git.mchehab+huawei@kernel.org \
--to=mchehab+huawei@kernel.org \
--cc=corbet@lwn.net \
--cc=linux-doc@vger.kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.