Skip to content

Commit

Permalink
Revise README
Browse files Browse the repository at this point in the history
- Change choice of words.
- Add links to repos.
  • Loading branch information
mchack-work committed Sep 3, 2024
1 parent 6014c37 commit 1e8b728
Showing 1 changed file with 30 additions and 22 deletions.
52 changes: 30 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,9 @@ and one closes the lid carefully by pressing in the middle of the jig
lift up on the lever.

The TP1 board supports two host computer tools to accommodate
programming of the TKey, either `iceprog` or `pynvcm`. See the
[developers handbook](https://dev.tillitis.se/tp1/) for more
elaborate description on how to use it.
programming of the TKey, either `iceprog` or `pynvcm`. See the chapter
in the [TKey Developer Handbook](https://dev.tillitis.se/tp1/) for a
more elaborate description on how to use it.

## Linux device permissions

Expand All @@ -24,15 +24,17 @@ Programmer USB device. This is a raw USB device that is probably not
taken care of by your distribution.

You can install a udev rule that will assign the TP1 to the dialout
group. You will also need to add your user to this group:
group. You will also need to add your user to the dialout group.

Create the following udev rule at `/etc/udev/rules.d`:

Create the following udev rule at `/etc/udev/rules.d`
```
# TP-1 programmer
SUBSYSTEM=="usb", ENV{DEVTYPE}=="usb_device", ATTR{idVendor}=="1209", ATTR{idProduct}=="8886", MODE="0666", GROUP="dialout"
```

To reload the rules run
To reload the rules run:

```
sudo udevadm control --reload-rules
sudo usermod -aG dialout ${USER}
Expand All @@ -51,17 +53,20 @@ Bus 001 Device 023: ID 1209:8886 Generic TP-1
```

Then, you can check the permissions by using the bus and device
numbers reported above. Note that this pair is ephimeral and may
change after every device insertion:
numbers reported above like this:

```
ls -l /dev/bus/usb/001/023
crw-rw---- 1 root dialout 189, 22 Feb 16 14:58 /dev/bus/usb/001/023
```

Note that this pair of numbers is ephemeral and may change after every
device insertion.

## Firmware
The TP1 board runs a custom firmware developed by Blinkinlabs. There
is also a pre-built firmware binary at `fw/bin/main.uf2`.
The TP1 board runs a custom firmware developed by Blinkinlabs for
Tillitis. There is also a pre-built firmware binary at
`fw/bin/main.uf2`.

To update the firmware, either build the file `main.uf2` (more
instructions below) or get the pre-built file to your host computer.
Expand Down Expand Up @@ -101,8 +106,8 @@ then run the build script in the `fw` folder
```

Note that our container image (tkey-builder) places the pico-sdk
directory in /usr/local. For normal development, it is usually left in
the user's home directory.
directory in `/usr/local`. For normal development, it is usually left
in the user's home directory.

See
[fw/README.md](https://github.com/tillitis/tp1/blob/main/fw//README.md)
Expand Down Expand Up @@ -143,7 +148,7 @@ make it easier to follow the license, both as a Licensor or a Licensee.

### Firmware
The firmware running on the TP1 is licensed under MIT License, see the
full license [fw/LICENSE](fw/LICENSE)
full license [fw/LICENSE](fw/LICENSE).

Copyright (c) 2023 Tillitis AB.

Expand All @@ -160,15 +165,18 @@ the `mta1-usb-v1-programmer`.


## History
This repo is created by filtering out relevant commits and files from
the tillitis/tillits-key1 repo.

The filtering removes all files and commits that are not related to
the tp1 hardware. This is done using `git-filter-repo`. To replicate
the results up until commit `f1158b1` in this repo, checkout commit
`354aecb` in tillitis/tillitis-key1 and run `git-filter-repo --path
hw/boards/tp1 --path hw/boards/mta1-usb-v1-programmer --path
hw/boards/KiCad-RP Pico`
This repo was created by filtering out relevant commits and files from
the [tillitis/tillits-key1](https://github.com/tillitis/tillitis-key1)
repo.

The filtering removed all files and commits that weren't related to
the tp1 hardware. This was done using
[git-filter-repo](https://github.com/newren/git-filter-repo).

To replicate the results up until commit `f1158b1` in this repo,
checkout commit `354aecb` in `tillitis/tillitis-key1` and run
`git-filter-repo --path hw/boards/tp1 --path
hw/boards/mta1-usb-v1-programmer --path hw/boards/KiCad-RP Pico`

All filtered commits have intact date, author, and code. Some
unrelated files are removed from some commits, but the commit messages
Expand Down

0 comments on commit 1e8b728

Please sign in to comment.