path: root/doc/main.md

# FT245 Bitbang Driver documentation

## FT245 synchronous FIFO protocol

The FT245 synchronous FIFO protocol consists of the following signals:

Data signals:

- `DATA0`: Parallel FIFO bus data I/O bit 0
- `DATA1`: Parallel FIFO bus data I/O bit 1
- `DATA2`: Parallel FIFO bus data I/O bit 2
- `DATA3`: Parallel FIFO bus data I/O bit 3
- `DATA4`: Parallel FIFO bus data I/O bit 4
- `DATA5`: Parallel FIFO bus data I/O bit 5
- `DATA6`: Parallel FIFO bus data I/O bit 6
- `DATA7`: Parallel FIFO bus data I/O bit 7
- `DATA8`: Parallel FIFO bus data I/O bit 8
- `DATA9`: Parallel FIFO bus data I/O bit 9
- `DATA10`: Parallel FIFO bus data I/O bit 10
- `DATA11`: Parallel FIFO bus data I/O bit 11
- `DATA12`: Parallel FIFO bus data I/O bit 12
- `DATA13`: Parallel FIFO bus data I/O bit 13
- `DATA14`: Parallel FIFO bus data I/O bit 14
- `DATA15`: Parallel FIFO bus data I/O bit 15
- `DATA16`: Parallel FIFO bus data I/O bit 16
- `DATA17`: Parallel FIFO bus data I/O bit 17
- `DATA18`: Parallel FIFO bus data I/O bit 18
- `DATA19`: Parallel FIFO bus data I/O bit 19
- `DATA20`: Parallel FIFO bus data I/O bit 20
- `DATA21`: Parallel FIFO bus data I/O bit 21
- `DATA22`: Parallel FIFO bus data I/O bit 22
- `DATA23`: Parallel FIFO bus data I/O bit 23
- `DATA24`: Parallel FIFO bus data I/O bit 24
- `DATA25`: Parallel FIFO bus data I/O bit 25
- `DATA26`: Parallel FIFO bus data I/O bit 26
- `DATA27`: Parallel FIFO bus data I/O bit 27
- `DATA28`: Parallel FIFO bus data I/O bit 28
- `DATA29`: Parallel FIFO bus data I/O bit 29
- `DATA30`: Parallel FIFO bus data I/O bit 30
- `DATA31`: Parallel FIFO bus data I/O bit 31
- `BE0`: Parallel FIFO bus byte enable I/O bit 0
- `BE1`: Parallel FIFO bus byte enable I/O bit 1
- `BE2`: Parallel FIFO bus byte enable I/O bit 2
- `BE3`: Parallel FIFO bus byte enable I/O bit 3

Control signals:

- `TXE_N`: Transmit FIFO Empty output signal. The signal indicates there is a minimum of 1 byte of space available to write to. Only write to the FIFO when this signal is logic 0.
- `RXF_N`: Receive FIFO Full output signal. The signal indicates there is a minimum of 1 byte of data available to read. Only read from the FIFO when this signal is logic 0.
- `SIWU_N`: Reserved
- `WR_N`: Write Enable input signal
- `RD_N`: Read Enable input signal
- `OE_N`: Data Output Enable input signal
- `RESET_N`: Chip Reset input, active low

For more information, look into the official FT245 synchronous FIFO protocol user manual.

## Static mode external functions

The following functions need to be implemented in your source code to be used by the driver:

- `void FT245_DATA0_to_input(void)`
- `void FT245_DATA1_to_input(void)`
- `void FT245_DATA2_to_input(void)`
- `void FT245_DATA3_to_input(void)`
- `void FT245_DATA4_to_input(void)`
- `void FT245_DATA5_to_input(void)`
- `void FT245_DATA6_to_input(void)`
- `void FT245_DATA7_to_input(void)`
- `void FT245_DATA8_to_input(void)`
- `void FT245_DATA9_to_input(void)`
- `void FT245_DATA10_to_input(void)`
- `void FT245_DATA11_to_input(void)`
- `void FT245_DATA12_to_input(void)`
- `void FT245_DATA13_to_input(void)`
- `void FT245_DATA14_to_input(void)`
- `void FT245_DATA15_to_input(void)`
- `void FT245_DATA16_to_input(void)`
- `void FT245_DATA17_to_input(void)`
- `void FT245_DATA18_to_input(void)`
- `void FT245_DATA19_to_input(void)`
- `void FT245_DATA20_to_input(void)`
- `void FT245_DATA21_to_input(void)`
- `void FT245_DATA22_to_input(void)`
- `void FT245_DATA23_to_input(void)`
- `void FT245_DATA24_to_input(void)`
- `void FT245_DATA25_to_input(void)`
- `void FT245_DATA26_to_input(void)`
- `void FT245_DATA27_to_input(void)`
- `void FT245_DATA28_to_input(void)`
- `void FT245_DATA29_to_input(void)`
- `void FT245_DATA30_to_input(void)`
- `void FT245_DATA31_to_input(void)`
- `void FT245_BE0_to_input(void)`
- `void FT245_BE1_to_input(void)`
- `void FT245_BE2_to_input(void)`
- `void FT245_BE3_to_input(void)`
- `void FT245_DATA0_to_output(void)`
- `void FT245_DATA1_to_output(void)`
- `void FT245_DATA2_to_output(void)`
- `void FT245_DATA3_to_output(void)`
- `void FT245_DATA4_to_output(void)`
- `void FT245_DATA5_to_output(void)`
- `void FT245_DATA6_to_output(void)`
- `void FT245_DATA7_to_output(void)`
- `void FT245_DATA8_to_output(void)`
- `void FT245_DATA9_to_output(void)`
- `void FT245_DATA10_to_output(void)`
- `void FT245_DATA11_to_output(void)`
- `void FT245_DATA12_to_output(void)`
- `void FT245_DATA13_to_output(void)`
- `void FT245_DATA14_to_output(void)`
- `void FT245_DATA15_to_output(void)`
- `void FT245_DATA16_to_output(void)`
- `void FT245_DATA17_to_output(void)`
- `void FT245_DATA18_to_output(void)`
- `void FT245_DATA19_to_output(void)`
- `void FT245_DATA20_to_output(void)`
- `void FT245_DATA21_to_output(void)`
- `void FT245_DATA22_to_output(void)`
- `void FT245_DATA23_to_output(void)`
- `void FT245_DATA24_to_output(void)`
- `void FT245_DATA25_to_output(void)`
- `void FT245_DATA26_to_output(void)`
- `void FT245_DATA27_to_output(void)`
- `void FT245_DATA28_to_output(void)`
- `void FT245_DATA29_to_output(void)`
- `void FT245_DATA30_to_output(void)`
- `void FT245_DATA31_to_output(void)`
- `void FT245_BE0_to_output(void)`
- `void FT245_BE1_to_output(void)`
- `void FT245_BE2_to_output(void)`
- `void FT245_BE3_to_output(void)`
- `void FT245_CLK_set(void)`
- `void FT245_RXF_N_set(void)`
- `void FT245_TXE_N_set(void)`
- `void FT245_DATA0_set(void)`
- `void FT245_DATA1_set(void)`
- `void FT245_DATA2_set(void)`
- `void FT245_DATA3_set(void)`
- `void FT245_DATA4_set(void)`
- `void FT245_DATA5_set(void)`
- `void FT245_DATA6_set(void)`
- `void FT245_DATA7_set(void)`
- `void FT245_DATA8_set(void)`
- `void FT245_DATA9_set(void)`
- `void FT245_DATA10_set(void)`
- `void FT245_DATA11_set(void)`
- `void FT245_DATA12_set(void)`
- `void FT245_DATA13_set(void)`
- `void FT245_DATA14_set(void)`
- `void FT245_DATA15_set(void)`
- `void FT245_DATA16_set(void)`
- `void FT245_DATA17_set(void)`
- `void FT245_DATA18_set(void)`
- `void FT245_DATA19_set(void)`
- `void FT245_DATA20_set(void)`
- `void FT245_DATA21_set(void)`
- `void FT245_DATA22_set(void)`
- `void FT245_DATA23_set(void)`
- `void FT245_DATA24_set(void)`
- `void FT245_DATA25_set(void)`
- `void FT245_DATA26_set(void)`
- `void FT245_DATA27_set(void)`
- `void FT245_DATA28_set(void)`
- `void FT245_DATA29_set(void)`
- `void FT245_DATA30_set(void)`
- `void FT245_DATA31_set(void)`
- `void FT245_BE0_set(void)`
- `void FT245_BE1_set(void)`
- `void FT245_BE2_set(void)`
- `void FT245_BE3_set(void)`
- `void FT245_CLK_reset(void)`
- `void FT245_RXF_N_reset(void)`
- `void FT245_TXE_N_reset(void)`
- `void FT245_DATA0_reset(void)`
- `void FT245_DATA1_reset(void)`
- `void FT245_DATA2_reset(void)`
- `void FT245_DATA3_reset(void)`
- `void FT245_DATA4_reset(void)`
- `void FT245_DATA5_reset(void)`
- `void FT245_DATA6_reset(void)`
- `void FT245_DATA7_reset(void)`
- `void FT245_DATA8_reset(void)`
- `void FT245_DATA9_reset(void)`
- `void FT245_DATA10_reset(void)`
- `void FT245_DATA11_reset(void)`
- `void FT245_DATA12_reset(void)`
- `void FT245_DATA13_reset(void)`
- `void FT245_DATA14_reset(void)`
- `void FT245_DATA15_reset(void)`
- `void FT245_DATA16_reset(void)`
- `void FT245_DATA17_reset(void)`
- `void FT245_DATA18_reset(void)`
- `void FT245_DATA19_reset(void)`
- `void FT245_DATA20_reset(void)`
- `void FT245_DATA21_reset(void)`
- `void FT245_DATA22_reset(void)`
- `void FT245_DATA23_reset(void)`
- `void FT245_DATA24_reset(void)`
- `void FT245_DATA25_reset(void)`
- `void FT245_DATA26_reset(void)`
- `void FT245_DATA27_reset(void)`
- `void FT245_DATA28_reset(void)`
- `void FT245_DATA29_reset(void)`
- `void FT245_DATA30_reset(void)`
- `void FT245_DATA31_reset(void)`
- `void FT245_BE0_reset(void)`
- `void FT245_BE1_reset(void)`
- `void FT245_BE2_reset(void)`
- `void FT245_BE3_reset(void)`
- `void FT245_CLK_toggle(void)`
- `uint32_t FT245_TXE_N_read(void)`
- `uint32_t FT245_RXF_N_read(void)`
- `uint32_t FT245_WR_N_read(void)`
- `uint32_t FT245_SIWU_N_read(void)`
- `uint32_t FT245_RD_N_read(void)`
- `uint32_t FT245_OE_N_read(void)`
- `uint32_t FT245_RST_N_read(void)`
- `uint32_t FT245_DATA0_read(void)`
- `uint32_t FT245_DATA1_read(void)`
- `uint32_t FT245_DATA2_read(void)`
- `uint32_t FT245_DATA3_read(void)`
- `uint32_t FT245_DATA4_read(void)`
- `uint32_t FT245_DATA5_read(void)`
- `uint32_t FT245_DATA6_read(void)`
- `uint32_t FT245_DATA7_read(void)`
- `uint32_t FT245_DATA8_read(void)`
- `uint32_t FT245_DATA9_read(void)`
- `uint32_t FT245_DATA10_read(void)`
- `uint32_t FT245_DATA11_read(void)`
- `uint32_t FT245_DATA12_read(void)`
- `uint32_t FT245_DATA13_read(void)`
- `uint32_t FT245_DATA14_read(void)`
- `uint32_t FT245_DATA15_read(void)`
- `uint32_t FT245_DATA16_read(void)`
- `uint32_t FT245_DATA17_read(void)`
- `uint32_t FT245_DATA18_read(void)`
- `uint32_t FT245_DATA19_read(void)`
- `uint32_t FT245_DATA20_read(void)`
- `uint32_t FT245_DATA21_read(void)`
- `uint32_t FT245_DATA22_read(void)`
- `uint32_t FT245_DATA23_read(void)`
- `uint32_t FT245_DATA24_read(void)`
- `uint32_t FT245_DATA25_read(void)`
- `uint32_t FT245_DATA26_read(void)`
- `uint32_t FT245_DATA27_read(void)`
- `uint32_t FT245_DATA28_read(void)`
- `uint32_t FT245_DATA29_read(void)`
- `uint32_t FT245_DATA30_read(void)`
- `uint32_t FT245_DATA31_read(void)`
- `uint32_t FT245_BE0_read(void)`
- `uint32_t FT245_BE1_read(void)`
- `uint32_t FT245_BE2_read(void)`
- `uint32_t FT245_BE3_read(void)`

For a detailed description on what these functions do, look at [FT245.md](FT245.md).

## Dynamic mode external functions

The following functions need to be implemented in your source code and assigned to the respective function pointers in `ft245_t` struct:

- `void (*DATA0_to_input)(void);`
- `void (*DATA1_to_input)(void);`
- `void (*DATA2_to_input)(void);`
- `void (*DATA3_to_input)(void);`
- `void (*DATA4_to_input)(void);`
- `void (*DATA5_to_input)(void);`
- `void (*DATA6_to_input)(void);`
- `void (*DATA7_to_input)(void);`
- `void (*DATA8_to_input)(void);`
- `void (*DATA9_to_input)(void);`
- `void (*DATA10_to_input)(void);`
- `void (*DATA11_to_input)(void);`
- `void (*DATA12_to_input)(void);`
- `void (*DATA13_to_input)(void);`
- `void (*DATA14_to_input)(void);`
- `void (*DATA15_to_input)(void);`
- `void (*DATA16_to_input)(void);`
- `void (*DATA17_to_input)(void);`
- `void (*DATA18_to_input)(void);`
- `void (*DATA19_to_input)(void);`
- `void (*DATA20_to_input)(void);`
- `void (*DATA21_to_input)(void);`
- `void (*DATA22_to_input)(void);`
- `void (*DATA23_to_input)(void);`
- `void (*DATA24_to_input)(void);`
- `void (*DATA25_to_input)(void);`
- `void (*DATA26_to_input)(void);`
- `void (*DATA27_to_input)(void);`
- `void (*DATA28_to_input)(void);`
- `void (*DATA29_to_input)(void);`
- `void (*DATA30_to_input)(void);`
- `void (*DATA31_to_input)(void);`
- `void (*BE0_to_input)(void);`
- `void (*BE1_to_input)(void);`
- `void (*BE2_to_input)(void);`
- `void (*BE3_to_input)(void);`
- `void (*DATA0_to_output)(void);`
- `void (*DATA1_to_output)(void);`
- `void (*DATA2_to_output)(void);`
- `void (*DATA3_to_output)(void);`
- `void (*DATA4_to_output)(void);`
- `void (*DATA5_to_output)(void);`
- `void (*DATA6_to_output)(void);`
- `void (*DATA7_to_output)(void);`
- `void (*DATA8_to_output)(void);`
- `void (*DATA9_to_output)(void);`
- `void (*DATA10_to_output)(void);`
- `void (*DATA11_to_output)(void);`
- `void (*DATA12_to_output)(void);`
- `void (*DATA13_to_output)(void);`
- `void (*DATA14_to_output)(void);`
- `void (*DATA15_to_output)(void);`
- `void (*DATA16_to_output)(void);`
- `void (*DATA17_to_output)(void);`
- `void (*DATA18_to_output)(void);`
- `void (*DATA19_to_output)(void);`
- `void (*DATA20_to_output)(void);`
- `void (*DATA21_to_output)(void);`
- `void (*DATA22_to_output)(void);`
- `void (*DATA23_to_output)(void);`
- `void (*DATA24_to_output)(void);`
- `void (*DATA25_to_output)(void);`
- `void (*DATA26_to_output)(void);`
- `void (*DATA27_to_output)(void);`
- `void (*DATA28_to_output)(void);`
- `void (*DATA29_to_output)(void);`
- `void (*DATA30_to_output)(void);`
- `void (*DATA31_to_output)(void);`
- `void (*BE0_to_output)(void);`
- `void (*BE1_to_output)(void);`
- `void (*BE2_to_output)(void);`
- `void (*BE3_to_output)(void);`
- `void (*CLK_set)(void);`
- `void (*RXF_N_set)(void);`
- `void (*TXE_N_set)(void);`
- `void (*DATA0_set)(void);`
- `void (*DATA1_set)(void);`
- `void (*DATA2_set)(void);`
- `void (*DATA3_set)(void);`
- `void (*DATA4_set)(void);`
- `void (*DATA5_set)(void);`
- `void (*DATA6_set)(void);`
- `void (*DATA7_set)(void);`
- `void (*DATA8_set)(void);`
- `void (*DATA9_set)(void);`
- `void (*DATA10_set)(void);`
- `void (*DATA11_set)(void);`
- `void (*DATA12_set)(void);`
- `void (*DATA13_set)(void);`
- `void (*DATA14_set)(void);`
- `void (*DATA15_set)(void);`
- `void (*DATA16_set)(void);`
- `void (*DATA17_set)(void);`
- `void (*DATA18_set)(void);`
- `void (*DATA19_set)(void);`
- `void (*DATA20_set)(void);`
- `void (*DATA21_set)(void);`
- `void (*DATA22_set)(void);`
- `void (*DATA23_set)(void);`
- `void (*DATA24_set)(void);`
- `void (*DATA25_set)(void);`
- `void (*DATA26_set)(void);`
- `void (*DATA27_set)(void);`
- `void (*DATA28_set)(void);`
- `void (*DATA29_set)(void);`
- `void (*DATA30_set)(void);`
- `void (*DATA31_set)(void);`
- `void (*BE0_set)(void);`
- `void (*BE1_set)(void);`
- `void (*BE2_set)(void);`
- `void (*BE3_set)(void);`
- `void (*CLK_reset)(void);`
- `void (*RXF_N_reset)(void);`
- `void (*TXE_N_reset)(void);`
- `void (*DATA0_reset)(void);`
- `void (*DATA1_reset)(void);`
- `void (*DATA2_reset)(void);`
- `void (*DATA3_reset)(void);`
- `void (*DATA4_reset)(void);`
- `void (*DATA5_reset)(void);`
- `void (*DATA6_reset)(void);`
- `void (*DATA7_reset)(void);`
- `void (*DATA8_reset)(void);`
- `void (*DATA9_reset)(void);`
- `void (*DATA10_reset)(void);`
- `void (*DATA11_reset)(void);`
- `void (*DATA12_reset)(void);`
- `void (*DATA13_reset)(void);`
- `void (*DATA14_reset)(void);`
- `void (*DATA15_reset)(void);`
- `void (*DATA16_reset)(void);`
- `void (*DATA17_reset)(void);`
- `void (*DATA18_reset)(void);`
- `void (*DATA19_reset)(void);`
- `void (*DATA20_reset)(void);`
- `void (*DATA21_reset)(void);`
- `void (*DATA22_reset)(void);`
- `void (*DATA23_reset)(void);`
- `void (*DATA24_reset)(void);`
- `void (*DATA25_reset)(void);`
- `void (*DATA26_reset)(void);`
- `void (*DATA27_reset)(void);`
- `void (*DATA28_reset)(void);`
- `void (*DATA29_reset)(void);`
- `void (*DATA30_reset)(void);`
- `void (*DATA31_reset)(void);`
- `void (*BE0_reset)(void);`
- `void (*BE1_reset)(void);`
- `void (*BE2_reset)(void);`
- `void (*BE3_reset)(void);`
- `void (*CLK_toggle)(void);`
- `uint32_t (*TXE_N_read)(void);`
- `uint32_t (*RXF_N_read)(void);`
- `uint32_t (*WR_N_read)(void);`
- `uint32_t (*SIWU_N_read)(void);`
- `uint32_t (*RD_N_read)(void);`
- `uint32_t (*OE_N_read)(void);`
- `uint32_t (*RST_N_read)(void);`
- `uint32_t (*DATA0_read)(void);`
- `uint32_t (*DATA1_read)(void);`
- `uint32_t (*DATA2_read)(void);`
- `uint32_t (*DATA3_read)(void);`
- `uint32_t (*DATA4_read)(void);`
- `uint32_t (*DATA5_read)(void);`
- `uint32_t (*DATA6_read)(void);`
- `uint32_t (*DATA7_read)(void);`
- `uint32_t (*DATA8_read)(void);`
- `uint32_t (*DATA9_read)(void);`
- `uint32_t (*DATA10_read)(void);`
- `uint32_t (*DATA11_read)(void);`
- `uint32_t (*DATA12_read)(void);`
- `uint32_t (*DATA13_read)(void);`
- `uint32_t (*DATA14_read)(void);`
- `uint32_t (*DATA15_read)(void);`
- `uint32_t (*DATA16_read)(void);`
- `uint32_t (*DATA17_read)(void);`
- `uint32_t (*DATA18_read)(void);`
- `uint32_t (*DATA19_read)(void);`
- `uint32_t (*DATA20_read)(void);`
- `uint32_t (*DATA21_read)(void);`
- `uint32_t (*DATA22_read)(void);`
- `uint32_t (*DATA23_read)(void);`
- `uint32_t (*DATA24_read)(void);`
- `uint32_t (*DATA25_read)(void);`
- `uint32_t (*DATA26_read)(void);`
- `uint32_t (*DATA27_read)(void);`
- `uint32_t (*DATA28_read)(void);`
- `uint32_t (*DATA29_read)(void);`
- `uint32_t (*DATA30_read)(void);`
- `uint32_t (*DATA31_read)(void);`
- `uint32_t (*BE0_read)(void);`
- `uint32_t (*BE1_read)(void);`
- `uint32_t (*BE2_read)(void);`
- `uint32_t (*BE3_read)(void);`

For a detailed description on what these functions do, look at [FT245.md](FT245.md).

## Runtime functions

The following functions are used to send/receive data in runtime after initialization:

- `bool FT245_write_buffered(ft245_t *ft245, uint8_t *data, size_t size);`
- `bool FT245_read_buffered(ft245_t *ft245, uint8_t *data, size_t size);`
- `bool FT245_write_word_buffered(ft245_t *ft245, uint32_t word);`
- `bool FT245_read_word_buffered(ft245_t *ft245, uint32_t *word);`
- `size_t FT245_available_read(ft245_t *ft245);`
- `size_t FT245_available_write(ft245_t *ft245);`

For a detailed description on what these functions do, look at [FT245.md](FT245.md).

## General usage

1. Include the `FT245.h` file into your source.
2. This driver can be used in static or dynamic mode. If you have just one FT245 master in your project, the static mode is recommended for simplicity and speed. If you have multiple FT245 masters in your project, dynamic mode is recommended to easier manage multiple FT245 instances.
  2.1. Static mode
    2.1.1. Set the define `FT245_DRIVER_MODE_STATIC` to `1` either before including `FT245.h` or inside `FT245.h`.
    2.1.2. Implement the `Static mode external functions` in your source code.
    2.1.3. Instantiate the `ft245_t` instance.
    2.1.4. Initialize the instance with `FT245_init(...)`.
  2.2. Dynamic mode
    2.2.1. Set the define `FT245_DRIVER_MODE_DYNAMIC` to `1` either before including `FT245.h` or inside `FT245.h`.
    2.2.2. Implement the `Dynamic mode external functions` in your source code.
    2.2.3. Instantiate a `ft245_t` instance for each FT245 in your setup.
    2.2.4. Assign the `Dynamic mode external functions` in the `ft245_t` instance to your implemented functions.
    2.2.5. Initialize each instance with `FT245_init(...)`.
3. Define the TX buffer size by setting `FT245_BUFFER_SIZE_TX` either before including `FT245.h` or inside `FT245.h`.
4. Define the RX buffer size by setting `FT245_BUFFER_SIZE_TX` either before including `FT245.h` or inside `FT245.h`.
5. Make sure the `FT245_periodic(...)` is called periodically, either via timer interrupt or in a loop.
6. Use the `Runtime functions` to send/receive data.