Update README.md

pull/197/head
matteo 2024-03-15 09:25:49 +01:00 zatwierdzone przez GitHub
rodzic 5a5acd2047
commit 310b7e5db5
Nie znaleziono w bazie danych klucza dla tego podpisu
ID klucza GPG: B5690EEEBB952194
1 zmienionych plików z 6 dodań i 17 usunięć

Wyświetl plik

@ -1,20 +1,3 @@
# MODIFIED CARIBOULITE
This is a non-official branch of cariboulite.
Features:
- performance upgrades
- transmission of arbitrary waveforms
The guide on how to use this version is in docs/notes/tutorial.md
___
_
___
_
___
_
# CaribouLite
CaribouLite is an affordable, educational, open-source SDR evaluation platform and a HAT for the Raspberry-Pi family of boards (40-pin versions only). It is built for makers, hackers, and researchers and was designed to complement the current SDR (Software Defined Radio) eco-systems offering with a scalable, standalone dual-channel software-defined radio.
@ -39,6 +22,7 @@ Due to the architectural changes in RPI5 - the new I/O controller called "RP1" c
So, if you intend to use CaribouLite on RPI5 please don't - it won't work. Why was the SMI interface deprecated by Broadcomm (either from its hardware or kernel SW support)? Most probably due to the same reason this interface was not documented in the first place - no interest in supporting a high-speed external interface within the 40-pin connector.
Edit: The workaround we are working to support RPI5 anyway - trying to utilize the Display and Camera I/O pins from the 40-pin connector to stream information - FPGA + Kernel module adaptation.
Edit2: A unofficial developer (Matteo Serva) is working on supporting the RPI5 by leveraging multiple SPI interfaces
# Getting Started & Installation
Use the following steps to install the CaribouLite on your choice of RPI board
@ -84,6 +68,11 @@ So currently, sudo'ing is needed whenever CaribouLite is accessed (including sud
To compile the API library and SoapySDR API from code please click [here](/software/libcariboulite/README.md)
# Transmitting a signal
There is an experimental feature for transmitting arbitrary waveforms.
The guide on how to use this version is [here](/docs/notes/tutorial.md)
# SMI Interface
Unlike many other HAT projects, CaribouLite utilizes the **SMI** (Secondary Memory Interface) present on all the 40-pin RPI versions. This interface is not thoroughly documented by both Raspberry-Pi documentation and Broadcomm's reference manuals. An amazing work done by [Lean2](https://iosoft.blog/2020/07/16/raspberry-pi-smi/) (code in [git repo](https://github.com/jbentham/rpi)) in hacking this interface has contributed to CaribouLite's technical feasibility. A deeper overview of the interface is provided by G.J. Van Loo, 2017 [Secondary_Memory_Interface.pdf](docs/smi/Secondary%20Memory%20Interface.pdf). The SMI interface allows exchanging up to ~500 Mbit/s (depending on the FPGA, data-bus width, etc.) between the RPI and the HAT, and yet, the results vary between the different versions of RPI. The results further depend on the specific RPI version's DMA speeds.