Skip to content

Commit

Permalink
Edit markdown formatting and page layout for consistency, clean up tr…
Browse files Browse the repository at this point in the history
…ailing spaces and unnecessary blank lines in code to address #87

Replace some horizontal lines with breaks for a better reading experience
Fix non-sequential numbering
Make title block on each page more uniform with consideration to adding relevant terminology for that page directly underneath the title (see open WIP checklist #62)

Move install directions for Chrultrabook Controller to post-install.md
Remove old information regarding running Windows on RW_LEGACY if using Ryzen
Remove accidental "reboot" instruction on purchasing-drivers.md
...and other various minor fixes
  • Loading branch information
sadlerm4 authored and ethanaobrien committed Nov 18, 2023
1 parent cb0570f commit 33d5b63
Show file tree
Hide file tree
Showing 24 changed files with 296 additions and 358 deletions.
2 changes: 1 addition & 1 deletion src/advanced/bugreport.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## Bug Reporting
# Bug Reporting

So you find a bug in one of our projects, and want to report it. It's faily simple,

Expand Down
5 changes: 3 additions & 2 deletions src/advanced/compiling-coreboot.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
### Cloning & Building ROMs

<br>
# Compiling Custom Firmware

## Cloning & Building ROMs

::: danger
Building and flashing your own firmware has the potential to brick your device. Do not do this unless you are sure you know what you're doing/have a way to recover from a bad flash. Some level of knowledge with using the Linux command line is required.
Expand Down
24 changes: 8 additions & 16 deletions src/advanced/contributing.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,18 @@
## Supporting the Docs

# Supporting the Docs
Want to help support the docs? Well there's some ways you can help!

------------
<br>

### Contributing via Issues
## Contributing via Issues

Contributing via Issues is pretty simple but there are some rules:

* Reserve the issues tab exclusively for documentation-related matters; refrain from discussing personal support issues or OS installation problems there.
* When reporting a typo or suggesting better clarification, please specify the page where the issue is found. It would be helpful to avoid searching extensively for these problems.

------------
---

### Contributing via PRs
## Contributing via PRs

Some guidelines when contributing via PRs:

Expand All @@ -23,14 +22,13 @@ Some guidelines when contributing via PRs:
* Additionally, it would be appreciated if you can provide sources for significant commits. This helps us verify the validity of the information you provide.
* Ensure that the pages adhere to the markdown style used in the docs.

------------
---

### How to Contribute
## How to Contribute

The best way to test your commits and ensure proper formatting is by forking the repository, making and testing changes locally, then contributing with a pull request.


**Simple step-by-step guide**
### Simple step-by-step guide

* Install NodeJS
* You can download NodeJS from [the NodeJS download page](https://nodejs.org/en/download).
Expand All @@ -43,9 +41,6 @@ The best way to test your commits and ensure proper formatting is by forking the
Vuepress will automatically regenerate pages when you make changes.
:::

------------


### Tips

Some tools that make contributing a bit easier:
Expand All @@ -54,6 +49,3 @@ Some tools that make contributing a bit easier:
* [Typora](https://typora.io) for real time markdown rendering.
* [TextMate](https://macromates.com) for easy and powerful mass find/replace.
* [GitHub Desktop](https://desktop.github.com) for more user friendly GUI.


------------
44 changes: 21 additions & 23 deletions src/advanced/debugging.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,18 @@
## Debugging

# Debugging
This page has instructions on using multiple different utilities to debug issues and modify parts of your system.

-----------
<br>

### Grabbing Logs
## Grabbing Logs

* If you're experiencing firmware bugs, provide output from `cbmem` console.
* If you're experiencing issues with Linux, provide output from `dmesg`, `dmidecode` and `journalctl` or `/var/log/messages`, respectively
* Ift you're experiencing issues with Windows, provide screenshots from Device Manager, Event Viewer, coredumps etc.
* If you're experiencing issues with Windows, provide screenshots from Device Manager, Event Viewer, coredumps etc.
* If you're experiencing issues with macOS, please ask for help in the Chrultrabook Discord, in the #hackintosh channel.

-----------
---

### Firmware
## Firmware

To debug firmware, you will need the following tools:

Expand All @@ -40,9 +39,10 @@ To interface with the Embedded Controller:
* Running `./ectool help` will provide you with a list of available commands, or you can take a look at ectool's source code directly:
https://chromium.googlesource.com/chromiumos/platform/ec/+/master/util/ectool.c#63

-----------
---

## SuzyQ Debug Cable

### SuzyQ Debug Cable
If you need to use SuzyQ, you can use `minicom` or `picocom` for example. It exposes three serial devices:
1. AP (CR50) console under /dev/ttyUSB0:
* `minicom -D /dev/ttyUSB0 -b 115200`
Expand All @@ -57,9 +57,9 @@ If you need to use SuzyQ, you can use `minicom` or `picocom` for example. It exp
* To use SuzyQ as platform debugger, you will also need to append the following to your kernel commandline:
`loglevel=15 console=ttyS4,115200n8`

-----------
---

### ACPI and Linux kernelspace
## ACPI and Linux kernelspace

1. Download our debugging script.
* `cd ~/Desktop;wget https://raw.githubusercontent.com/chrultrabook/linux-tools/main/debugging.sh`
Expand All @@ -80,14 +80,13 @@ If you need to use SuzyQ, you can use `minicom` or `picocom` for example. It exp
3. Upload this file if you need help with troubleshooting.
* Remember to remove WiFi information from dmesg to protect your privacy.

-----------
---

### flashrom
## flashrom

Flashrom is used to read and write from the SPI flash


Read flash:
### Read flash:
* `sudo flashrom -p <programmer> -r <filename.rom>`
* Example:
* `sudo flashrom -p internal -r backup.rom`
Expand All @@ -96,35 +95,35 @@ Read flash:
If you have an Intel Chromebook, you will need to add `--ifd -i bios` if you want to write to the flash or else flashrom will fail.
:::

Write flash:
### Write flash:
* `sudo flashrom -p <programmer> -w <filename.rom>`
* Intel Example:
* `sudo flashrom -p internal --ifd -i bios -w stock.rom`
* AMD Example:
* `sudo flashrom -p internal -w stock.rom`

Write protection:
### Write protection:

View status:
* `sudo flashrom -p internal --wp-status`

Enable WP:
* `sudo flashrom -p internal --wp-enable`
* `sudo flashrom -p internal --wp-enable`

Disable WP:
* `sudo flashrom -p internal --wp-disable`
* `sudo flashrom -p internal --wp-disable`

Clear WP range:
* `sudo flashrom -p internal --wp-range 0 0`
* `sudo flashrom -p internal --wp-range 0 0`

Common programmers:
* `internal`: Use this when you run flashrom on the chromebook you want to program.
* `ch341a_spi`: Use this when you use a ch341a external programmer.
* `raiden_debug_spi:target=AP`: Use then when you want to flash using a Suzy-Q cable.

-----------
---

### gsctool
## gsctool

gsctool is used to communicate with the GSC (Google Security Chip) from ChromeOS and is usually used to unlock CCD without removing the back of the Chromebook.

Expand All @@ -135,4 +134,3 @@ Unlock CCD:
* `sudo gsctool -a -o`
* This will prompt you multiple times to press the power button, on the last time, the device will reboot back into verified mode


31 changes: 9 additions & 22 deletions src/advanced/unbrick-flipper.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
## Unbricking with a Flipper Zero
# Unbricking with a Flipper Zero
Yes, this is possible.

### Prerequisites
<br>

## Prerequisites
- Your brain (please)
- A Flipper Zero with up-to-date firmware
- It doesn't matter if you're using stock or custom FW.
Expand All @@ -11,62 +13,47 @@ Yes, this is possible.
- A copy of your stock ROM
- A way to copy files onto your Flipper Zero



----------------

### Preparations
## Preparations
1. Locate the SPI flash chip (See [Unbricking Page](unbricking.html), under "Hardware Disassembly")
2. A understanding that this may not work on your system

----------------
<br>

::: danger
**You will NOT be able to preserve the VPD using this method! This will not apply to you if flashing via your backup ROM.** Read the [Unbricking Page](unbricking.html) for more information.
:::


### Step 1
Obtain your stock ROM and rename it to `.bin`. For this guide, I will be using qFlipper. Your rom file should now look like this:
<br>
![binexample](https://github.com/chrultrabook/docs/assets/77316348/0973c451-00c5-424b-96cc-23e0d66f1960)

![binexample](https://github.com/chrultrabook/docs/assets/77316348/0973c451-00c5-424b-96cc-23e0d66f1960)

### Step 2
Locate the `spi_mem_manager` folder under the path `SD Card/apps_data/spi_mem_manager/`. Copy the .bin file to this newly made folder.
<br>
Locate the `spi_mem_manager` folder under the path `SD Card/apps_data/spi_mem_manager/`. Copy the .bin file to this newly made folder.

::: tip
You might see a file size warning. It is safe to ignore it, only files that are 4GB+ will have issues transferring.
:::

Your `spi_mem_manager/` folder should now look like this:
<br>

![image](https://github.com/chrultrabook/docs/assets/77316348/60ae0581-8b31-413a-82d7-e70469763cf5)

### Step 3
On your Flipper Zero, go to `Apps -> GPIO -> SPI Mem Manager -> Saved`. You should see your backup .bin. Verify that the file is there, then proceed to the next step.


### Step 4
Connect your SOIC clip chip to your GPIO pins now. See the image below for the wire setup.

![image](https://raw.githubusercontent.com/chrultrabook/docs/testing/assets/flipperunbrick/GPIOSetup.png)


### Step 5
Go back to `Apps -> GPIO -> SPI Mem Manager -> Saved -> Yourfilename.bim`. Open the file, then select the option to "Write".


### Step 6
Assuming all went well, you should no longer have a unbricked system.
<br>

----------------

<br>
---

#### Got Questions?
## Got Questions?
Please ask in the Chrultrabook Discord, or email me (meghan6) at ([email protected]).
Loading

0 comments on commit 33d5b63

Please sign in to comment.