From efd8b0a08ac9439845c2c2f9d50d30cda8692421 Mon Sep 17 00:00:00 2001 From: Leonard Kugis Date: Wed, 22 May 2024 02:42:08 +0200 Subject: Read-functions: Returning 'bool' to reflect signal state. --- doc/FT245.md | 345 +++++++++++++++++++++++++++++------------------------------ 1 file changed, 172 insertions(+), 173 deletions(-) (limited to 'doc/FT245.md') diff --git a/doc/FT245.md b/doc/FT245.md index 7ffea0e..37638e8 100644 --- a/doc/FT245.md +++ b/doc/FT245.md @@ -608,393 +608,392 @@ Sets the `BE3` signal to low. Toggles the `CLK` signal. -### `uint32_t FT245_TXE_N_read(void)` +### `bool FT245_TXE_N_read(void)` Reads the `TXE_N` signal. Returns: -- `0`: Signal is low. -- `!= 0`: Signal is high. +- `false`: Signal is low. +- `true`: Signal is high. -### `uint32_t FT245_RXF_N_read(void)` +### `bool FT245_RXF_N_read(void)` Reads the `RXF_N` signal. Returns: -- `0`: Signal is low. -- `!= 0`: Signal is high. +- `false`: Signal is low. +- `true`: Signal is high. -### `uint32_t FT245_WR_N_read(void)` +### `bool FT245_WR_N_read(void)` Reads the `WR_N` signal. Returns: -- `0`: Signal is low. -- `!= 0`: Signal is high. +- `false`: Signal is low. +- `true`: Signal is high. -### `uint32_t FT245_SIWU_N_read(void)` +### `bool FT245_SIWU_N_read(void)` Reads the `SIWU_N` signal. Returns: -- `0`: Signal is low. -- `!= 0`: Signal is high. +- `false`: Signal is low. +- `true`: Signal is high. -### `uint32_t FT245_RD_N_read(void)` +### `bool FT245_RD_N_read(void)` Reads the `RD_N` signal. Returns: -- `0`: Signal is low. -- `!= 0`: Signal is high. +- `false`: Signal is low. +- `true`: Signal is high. -### `uint32_t FT245_OE_N_read(void)` +### `bool FT245_OE_N_read(void)` Reads the `OE_N` signal. Returns: -- `0`: Signal is low. -- `!= 0`: Signal is high. +- `false`: Signal is low. +- `true`: Signal is high. -### `uint32_t FT245_RST_N_read(void)` +### `bool FT245_RST_N_read(void)` Reads the `RST_N` signal. Returns: -- `0`: Signal is low. -- `!= 0`: Signal is high. +- `false`: Signal is low. +- `true`: Signal is high. -### `uint32_t FT245_DATA0_read(void)` +### `bool FT245_DATA0_read(void)` Reads the `DATA0` signal. Returns: -- `0`: Signal is low. -- `!= 0`: Signal is high. +- `false`: Signal is low. +- `true`: Signal is high. -### `uint32_t FT245_DATA1_read(void)` +### `bool FT245_DATA1_read(void)` Reads the `DATA1` signal. Returns: -- `0`: Signal is low. -- `!= 0`: Signal is high. +- `false`: Signal is low. +- `true`: Signal is high. -### `uint32_t FT245_DATA2_read(void)` +### `bool FT245_DATA2_read(void)` Reads the `DATA2` signal. Returns: -- `0`: Signal is low. -- `!= 0`: Signal is high. +- `false`: Signal is low. +- `true`: Signal is high. -### `uint32_t FT245_DATA3_read(void)` +### `bool FT245_DATA3_read(void)` Reads the `DATA3` signal. Returns: -- `0`: Signal is low. -- `!= 0`: Signal is high. +- `false`: Signal is low. +- `true`: Signal is high. -### `uint32_t FT245_DATA4_read(void)` +### `bool FT245_DATA4_read(void)` Reads the `DATA4` signal. Returns: -- `0`: Signal is low. -- `!= 0`: Signal is high. +- `false`: Signal is low. +- `true`: Signal is high. -### `uint32_t FT245_DATA5_read(void)` +### `bool FT245_DATA5_read(void)` Reads the `DATA5` signal. Returns: -- `0`: Signal is low. -- `!= 0`: Signal is high. +- `false`: Signal is low. +- `true`: Signal is high. -### `uint32_t FT245_DATA6_read(void)` +### `bool FT245_DATA6_read(void)` Reads the `DATA6` signal. Returns: -- `0`: Signal is low. -- `!= 0`: Signal is high. +- `false`: Signal is low. +- `true`: Signal is high. -### `uint32_t FT245_DATA7_read(void)` +### `bool FT245_DATA7_read(void)` Reads the `DATA7` signal. Returns: -- `0`: Signal is low. -- `!= 0`: Signal is high. +- `false`: Signal is low. +- `true`: Signal is high. - -### `uint32_t FT245_DATA8_read(void)` +### `bool FT245_DATA8_read(void)` Reads the `DATA8` signal. Returns: -- `0`: Signal is low. -- `!= 0`: Signal is high. +- `false`: Signal is low. +- `true`: Signal is high. -### `uint32_t FT245_DATA9_read(void)` +### `bool FT245_DATA9_read(void)` Reads the `DATA9` signal. Returns: -- `0`: Signal is low. -- `!= 0`: Signal is high. +- `false`: Signal is low. +- `true`: Signal is high. -### `uint32_t FT245_DATA10_read(void)` +### `bool FT245_DATA10_read(void)` Reads the `DATA10` signal. Returns: -- `0`: Signal is low. -- `!= 0`: Signal is high. +- `false`: Signal is low. +- `true`: Signal is high. -### `uint32_t FT245_DATA11_read(void)` +### `bool FT245_DATA11_read(void)` Reads the `DATA11` signal. Returns: -- `0`: Signal is low. -- `!= 0`: Signal is high. +- `false`: Signal is low. +- `true`: Signal is high. -### `uint32_t FT245_DATA12_read(void)` +### `bool FT245_DATA12_read(void)` Reads the `DATA12` signal. Returns: -- `0`: Signal is low. -- `!= 0`: Signal is high. +- `false`: Signal is low. +- `true`: Signal is high. -### `uint32_t FT245_DATA13_read(void)` +### `bool FT245_DATA13_read(void)` Reads the `DATA13` signal. Returns: -- `0`: Signal is low. -- `!= 0`: Signal is high. +- `false`: Signal is low. +- `true`: Signal is high. -### `uint32_t FT245_DATA14_read(void)` +### `bool FT245_DATA14_read(void)` Reads the `DATA14` signal. Returns: -- `0`: Signal is low. -- `!= 0`: Signal is high. +- `false`: Signal is low. +- `true`: Signal is high. -### `uint32_t FT245_DATA15_read(void)` +### `bool FT245_DATA15_read(void)` Reads the `DATA15` signal. Returns: -- `0`: Signal is low. -- `!= 0`: Signal is high. +- `false`: Signal is low. +- `true`: Signal is high. -### `uint32_t FT245_DATA16_read(void)` +### `bool FT245_DATA16_read(void)` Reads the `DATA16` signal. Returns: -- `0`: Signal is low. -- `!= 0`: Signal is high. +- `false`: Signal is low. +- `true`: Signal is high. -### `uint32_t FT245_DATA17_read(void)` +### `bool FT245_DATA17_read(void)` Reads the `DATA17` signal. Returns: -- `0`: Signal is low. -- `!= 0`: Signal is high. +- `false`: Signal is low. +- `true`: Signal is high. -### `uint32_t FT245_DATA18_read(void)` +### `bool FT245_DATA18_read(void)` Reads the `DATA18` signal. Returns: -- `0`: Signal is low. -- `!= 0`: Signal is high. +- `false`: Signal is low. +- `true`: Signal is high. -### `uint32_t FT245_DATA19_read(void)` +### `bool FT245_DATA19_read(void)` Reads the `DATA19` signal. Returns: -- `0`: Signal is low. -- `!= 0`: Signal is high. +- `false`: Signal is low. +- `true`: Signal is high. -### `uint32_t FT245_DATA20_read(void)` +### `bool FT245_DATA20_read(void)` Reads the `DATA20` signal. Returns: -- `0`: Signal is low. -- `!= 0`: Signal is high. +- `false`: Signal is low. +- `true`: Signal is high. -### `uint32_t FT245_DATA21_read(void)` +### `bool FT245_DATA21_read(void)` Reads the `DATA21` signal. Returns: -- `0`: Signal is low. -- `!= 0`: Signal is high. +- `false`: Signal is low. +- `true`: Signal is high. -### `uint32_t FT245_DATA22_read(void)` +### `bool FT245_DATA22_read(void)` Reads the `DATA22` signal. Returns: -- `0`: Signal is low. -- `!= 0`: Signal is high. +- `false`: Signal is low. +- `true`: Signal is high. -### `uint32_t FT245_DATA23_read(void)` +### `bool FT245_DATA23_read(void)` Reads the `DATA23` signal. Returns: -- `0`: Signal is low. -- `!= 0`: Signal is high. +- `false`: Signal is low. +- `true`: Signal is high. -### `uint32_t FT245_DATA24_read(void)` +### `bool FT245_DATA24_read(void)` Reads the `DATA24` signal. Returns: -- `0`: Signal is low. -- `!= 0`: Signal is high. +- `false`: Signal is low. +- `true`: Signal is high. -### `uint32_t FT245_DATA25_read(void)` +### `bool FT245_DATA25_read(void)` Reads the `DATA25` signal. Returns: -- `0`: Signal is low. -- `!= 0`: Signal is high. +- `false`: Signal is low. +- `true`: Signal is high. -### `uint32_t FT245_DATA26_read(void)` +### `bool FT245_DATA26_read(void)` Reads the `DATA26` signal. Returns: -- `0`: Signal is low. -- `!= 0`: Signal is high. +- `false`: Signal is low. +- `true`: Signal is high. -### `uint32_t FT245_DATA27_read(void)` +### `bool FT245_DATA27_read(void)` Reads the `DATA27` signal. Returns: -- `0`: Signal is low. -- `!= 0`: Signal is high. +- `false`: Signal is low. +- `true`: Signal is high. -### `uint32_t FT245_DATA28_read(void)` +### `bool FT245_DATA28_read(void)` Reads the `DATA28` signal. Returns: -- `0`: Signal is low. -- `!= 0`: Signal is high. +- `false`: Signal is low. +- `true`: Signal is high. -### `uint32_t FT245_DATA29_read(void)` +### `bool FT245_DATA29_read(void)` Reads the `DATA29` signal. Returns: -- `0`: Signal is low. -- `!= 0`: Signal is high. +- `false`: Signal is low. +- `true`: Signal is high. -### `uint32_t FT245_DATA30_read(void)` +### `bool FT245_DATA30_read(void)` Reads the `DATA30` signal. Returns: -- `0`: Signal is low. -- `!= 0`: Signal is high. +- `false`: Signal is low. +- `true`: Signal is high. -### `uint32_t FT245_DATA31_read(void)` +### `bool FT245_DATA31_read(void)` Reads the `DATA31` signal. Returns: -- `0`: Signal is low. -- `!= 0`: Signal is high. +- `false`: Signal is low. +- `true`: Signal is high. -### `uint32_t FT245_BE0_read(void)` +### `bool FT245_BE0_read(void)` Reads the `BE0` signal. Returns: -- `0`: Signal is low. -- `!= 0`: Signal is high. +- `false`: Signal is low. +- `true`: Signal is high. -### `uint32_t FT245_BE1_read(void)` +### `bool FT245_BE1_read(void)` Reads the `BE1` signal. Returns: -- `0`: Signal is low. -- `!= 0`: Signal is high. +- `false`: Signal is low. +- `true`: Signal is high. -### `uint32_t FT245_BE2_read(void)` +### `bool FT245_BE2_read(void)` Reads the `BE2` signal. Returns: -- `0`: Signal is low. -- `!= 0`: Signal is high. +- `false`: Signal is low. +- `true`: Signal is high. -### `uint32_t FT245_BE3_read(void)` +### `bool FT245_BE3_read(void)` Reads the `BE3` signal. Returns: -- `0`: Signal is low. -- `!= 0`: Signal is high. +- `false`: Signal is low. +- `true`: Signal is high. ## Dynamic mode external functions @@ -1151,49 +1150,49 @@ The following functions need to be implemented in your source code and assigned - `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);` +- `bool (*TXE_N_read)(void);` +- `bool (*RXF_N_read)(void);` +- `bool (*WR_N_read)(void);` +- `bool (*SIWU_N_read)(void);` +- `bool (*RD_N_read)(void);` +- `bool (*OE_N_read)(void);` +- `bool (*RST_N_read)(void);` +- `bool (*DATA0_read)(void);` +- `bool (*DATA1_read)(void);` +- `bool (*DATA2_read)(void);` +- `bool (*DATA3_read)(void);` +- `bool (*DATA4_read)(void);` +- `bool (*DATA5_read)(void);` +- `bool (*DATA6_read)(void);` +- `bool (*DATA7_read)(void);` +- `bool (*DATA8_read)(void);` +- `bool (*DATA9_read)(void);` +- `bool (*DATA10_read)(void);` +- `bool (*DATA11_read)(void);` +- `bool (*DATA12_read)(void);` +- `bool (*DATA13_read)(void);` +- `bool (*DATA14_read)(void);` +- `bool (*DATA15_read)(void);` +- `bool (*DATA16_read)(void);` +- `bool (*DATA17_read)(void);` +- `bool (*DATA18_read)(void);` +- `bool (*DATA19_read)(void);` +- `bool (*DATA20_read)(void);` +- `bool (*DATA21_read)(void);` +- `bool (*DATA22_read)(void);` +- `bool (*DATA23_read)(void);` +- `bool (*DATA24_read)(void);` +- `bool (*DATA25_read)(void);` +- `bool (*DATA26_read)(void);` +- `bool (*DATA27_read)(void);` +- `bool (*DATA28_read)(void);` +- `bool (*DATA29_read)(void);` +- `bool (*DATA30_read)(void);` +- `bool (*DATA31_read)(void);` +- `bool (*BE0_read)(void);` +- `bool (*BE1_read)(void);` +- `bool (*BE2_read)(void);` +- `bool (*BE3_read)(void);` The functions descriptions are the same as for static mode. You can even assign your implemented static mode functions to the dynamic mode function pointers. -- cgit v1.2.1