#include "head.html"

# pico-ice

#include "menu.html"

## Download

### Beta Release

ueforth-pico-ice-{{VERSION}}.zip
Version: {{VERSION}} (Beta)

Release Archive - Prior Releases

http://github.com/flagxor/ueforth - Complete Unprocessed Source Code

## License

NOTE: Although ueforth is licensed under Apache 2.0, please be aware that binaries are built with SDKs that include other licenses including MIT, Raspberry Pi License, and possibly others. Be sure to consult a lawyer before using for comercial purposes.

    Copyright 2023 Bradley D. Nelson

    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.
    You may obtain a copy of the License at

        http://www.apache.org/licenses/LICENSE-2.0

    Unless required by applicable law or agreed to in writing, software
    distributed under the License is distributed on an "AS IS" BASIS,
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
    limitations under the License.

## Install

- Connect your pico-ice to USB.
- Connect the USB_BOOT pin to ground.
- Press reset on the pico-ice.
- Copy ueforth-pico-ice.uf2 to the mounted drive.

See detailed instructions for MCU programming

## Use

Initially µEforth can be interacted with over a serial port (over USB). One popular option is to use the serial port option on PuTTY. Be sure to config the serial port to: `baud rate = 115200, data bits = 8, stop bits = 1, and parity = N`.

## pico-ice Features

### pico-ice Words

#include "common.html"

### pico-ice Bindings

##### Allocation

These words are inside the `internals` vocabulary.

    MALLOC ( n -- a | 0 )   System malloc
    SYSFREE ( a -- )   System free
    REALLOC ( a n -- a | 0 )   System realloc

##### System

    MS ( n -- ) Pause for some number of milliseconds.
    MS-TICKS ( -- n ) Time since start in milliseconds.
    TERMINATE ( n -- ) Call system exit.

##### Files

    R/O ( -- mode )
    R/W ( -- mode )
    W/O ( -- mode )
    BIN ( mode -- mode )
    CLOSE-FILE ( fh -- ior )
    OPEN-FILE ( a n mode -- fh ior )
    CREATE-FILE ( a n mode -- fh ior )
    DELETE-FILE ( a n -- ior )
    WRITE-FILE ( a n fh -- ior )
    READ-FILE ( a n fh -- n ior )
    FILE-POSITION ( fh -- n ior )
    REPOSITION-FILE ( n fh -- ior )
    FILE-SIZE ( fh -- n ior )

##### pico

These words are inside the `pico` vocabulary. See here for details on the underlying hardware SDK.

    adc_init ( -- ) Initialize HW ADC
    adc_gpio_init ( n -- ) Init GPIO for use as ADC
    adc_select_input ( n -- ) Select ADC input
    adc_get_selected_input ( -- n ) Get selected ADC input
    adc_set_round_robin ( mask -- ) Round robin sampler selector
    adc_set_temp_sensor_enabled ( f -- ) Enable/disable onboard tempurature sensor
    adc_read ( -- u ) Perform a single conversion
    adc_run ( f -- ) Enable/disable free-running sample mode
    adc_set_clkdiv ( f: clkdiv -- ) Set ADC clock divisor
    adc_fifo_setup ( en dreq_en dreq_thresh err_in_fifo byte_shift -- ) Setup ADC FIFO
    adc_fifo_is_empty ( -- f ) Check FIFO empty state
    adc_fifo_get_level ( -- n ) Get number ADC FIFO entries
    adc_fifo_get ( -- n ) Get ADC result from FIFO
    adc_fifo_drain ( -- ) Drain FIFO.
    adc_fifo_get_blocking ( -- n ) Wait for ADC to have data
    adc_irq_set_enabled ( f -- ) Enable/disable ADC interrupts

##### ice

These words are inside the `ice` vocabulary. See here for details on the underlying SDK.

    ice_cram_open ( -- ) Open FPGA config RAM connection.
    ice_cram_write ( a n -- ) Write bytes to the FPGA config RAM connection.
    ice_cram_close ( -- ) Close FPGA config RAM connection.

    ICE_FLASH_PAGE_SIZE ( -- n ) Get the size of a flash page.
    ice_flash_init ( -- ) Init flash connection.
    ice_flash_read ( addr a n -- ) Read from a flash address to a buffer.
    ice_flash_erase_sector ( n -- ) Erase a flash sector.
    ice_flash_program_page ( addr a -- ) Program a flash page.
    ice_flash_erase_chip ( -- ) Erase whole flash.
    ice_flash_wakeup ( -- ) Wakeup flash.
    ice_flash_sleep ( -- ) Put flash in sleep mode.

    ice_fpga_init ( n -- ) Init FPGA to a clock speed in MHz.
                           Valid inputs: 1, 2, 3, 4, 6, 8, 12, 16, 24, 48
    ice_fpga_start ( -- ) Start FPGA.
    ice_fpga_stop ( -- ) Stop FPGA.

    ice_led_init ( -- ) Initialize LED.
    ice_led_red ( f -- ) Set on/off state of led red channel.
    ice_led_green ( f -- ) Set on/off state of led green channel.
    ice_led_blue ( f -- ) Set on/off state of led blue channel.

    ice_spi_init ( -- ) Initialize SPI.
    ice_spi_init_cs_pin ( cs_pin active_high -- ) Init selecting more options.
    ice_spi_chip_select ( n -- ) Set csn_pin to assert.
                                 Also set the SPI TX and SCK pins to output/drive mode,
                                 and keeps the RX pin to input/high-z mode.
    ice_spi_chip_deselect ( n -- ) Set csn_pin to assert.
                                   Also set the SPI TX and SCK pins back to input/high-z mode.
    ice_spi_read_blocking ( a n -- ) Read from SPI into buffer.
    ice_spi_write_blocking ( a n -- ) Write to SPI from buffer.

    ice_sram_init ( -- ) Initialize SRAM.
    ice_sram_get_id ( a -- ) Read SRAM id into 8 byte buffer.
    ice_sram_read_blocking ( addr a n -- ) Read from address in SRAM to memory.
    ice_sram_write_blocking ( addr a n -- ) Write from memory to SRAM.