Merge pull request #65 from xmos/release/v5.7.0

Release/v5.7.0

CHANGELOG.md

@@ -1,5 +1,9 @@
 # VocalFusion Raspberry Pi Setup Change Log
 
+## 5.7.0
+
+  * Update Raspbian image to Bullseye (2023-02-21-raspios-bullseye-armhf)
+
 ## 5.6.0
 
   * No Pi->XVF3800 MCLK drive by default. Use xvf3800-int-dev-extmclk to enable this

README.md

@@ -2,9 +2,6 @@
 
 This repository provides a simple-to-use automated script to configure the Raspberry Pi to use **xCORE VocalFusion** for audio.
 
-**Note:** This repository is designed for use within the following **xCORE VocalFusion** repository:
-- xCORE VocalFusion Kit for AVS: https://github.com/xmos/vocalfusion-avs-setup
-
 This setup will perform the following operations:
 
 - enable the I2S, I2C and SPI interfaces
@@ -51,29 +48,28 @@ For XVF3510-UA and XVF361x-UA devices these actions will be done as well:
 
 ## Setup
 
-1. First, obtain the required version of the Raspberry Pi operating system, which is available here:
-
-   https://downloads.raspberrypi.org/raspbian/images/raspbian-2020-02-14/2020-02-13-raspbian-buster.zip
+1. First, obtain the required version of the Raspberry Pi operating system, which is available [here](https://downloads.raspberrypi.org/raspios_armhf/images/raspios_armhf-2023-02-22/2023-02-21-raspios-bullseye-armhf.img.xz)
 
-   We cannot use the latest as updates to linux kernel v5 have broken the I2S sub-system.
+   We cannot use the latest as updates to Linux kernel v5 have broken the I2S sub-system.
 
-   Then, install the Raspberry Pi Imager on a host computer. Raspberry Pi Imager is available here:
-
-   https://www.raspberrypi.org/software/
+   Then, install the Raspberry Pi Imager on a host computer. Raspberry Pi Imager is available [here](https://www.raspberrypi.org/software/)
 
    Run the Raspberry Pi Imager, and select the 'CHOOSE OS' button. Scroll to the bottom of the displayed list, and select "Use custom".
-   Then select the file downloaded above (2020-02-13-raspbian-buster.zip) and select "Open". The archive file does not have to be unzipped, the imager software will do that.
+   Then select the file downloaded above (2023-02-21-raspios-bullseye-armhf.img.xz) and select "Open". The archive file does not have to be unzipped, the imager software will do that.
 
    Select the CHOOSE SD CARD button to which to download the image, and then select the "WRITE" button.
 
    When prompted, remove the written SD card and insert it into the Raspberry Pi.
 
 2. Connect up the keyboard, mouse, speakers and display to the Raspberry Pi and power up the system. Refer to the **Getting Started Guide** for you platform.
 
-   **DO NOT** follow the prompt to update the software on the system. Set up the locale, and setup a network connect, but **DO NOT** update the software on the Raspberry Pi. This will update the kernel, and then the audio sub-system will not work.
+   **DO NOT** follow the prompt to "Update Software" on the system. Set up the locale, username, password and a network connection, but **DO NOT** update the software on the Raspberry Pi. This will update the kernel, and then the audio sub-system will not work.
+
+**_NOTE:_** Headless installation forces an upgrade of the software, so it cannot be used for this setup.
 
+**_NOTE:_** Host applications and scripts used by the XMOS products support only 32-bit Raspbian systems.
 
-3. On the Raspberry Pi, clone the Github repository https://github.com/xmos/vocalfusion-rpi-setup:
+3. On the Raspberry Pi, clone the Github repository below:
 
    ```git clone https://github.com/xmos/vocalfusion-rpi-setup```
 

resources/clk_dac_setup/setup_io_exp_and_dac.py

@@ -97,7 +97,7 @@ def setup_io_expander(bus, args):
                              (1<<DAC_RST_N_PIN) | \
                              (1<<MCLK_OE_PIN)   | \
                              (1<<BOOT_SEL_PIN)
-                             #I2S, MCLK and SPI all enabled so we can drive from host to xvf3800     
+                             #I2S and SPI enabled so we can drive from host to xvf3800     
 
         # Enable the MCLK level shifter so we can route MCLK from Pi to xvf3800. Clear MCLK_OE so it drives
         # from the Pi to the xvf3800. Note only used in extmclk configurations