This is the primary header file for the Platform Library.
For information on the use of this API, see CrossWorks Platform Library.
| General | |
| platform_cpu_name | Platform CPU name |
| platform_initialize | Initialize Platform Library |
| platform_name | Platform name |
| Pins | |
| PLATFORM_PIN_CLAIM_t | Pin claim requirements |
| PLATFORM_PIN_CONFIGURATION_t | Pin configuration request structure |
| PLATFORM_PIN_CONNECTION_t | Pin connection |
| PLATFORM_PIN_FUNCTION_t | Pin function requirements |
| platform_claim_multi_pin | Claim multiple platform pins |
| platform_claim_pin | Claim platform pin |
| platform_claim_pin_configuration | Claim a configuration of platform pins |
| platform_lock_pin | Lock pin |
| platform_lock_pin_configuration | Lock a pin configuration |
| platform_pin_catalog | Pin catalog |
| platform_pin_catalog_count | Number of entries in pin catalog |
| platform_pin_connection_name | Get connection name for a pin |
| platform_pin_function | Registered platform pin function |
| platform_pin_signal_name | Get signal name for a pin |
| platform_release_pin | Release pin |
| I/O | |
| platform_read_analog_pin | Read analog input |
| platform_read_digital_pin | Read digital input |
| platform_write_analog_pin | Write analog output |
| platform_write_digital_pin | Write digital output |
| Buttons | |
| PLATFORM_BUTTON_ATTRIBUTE_t | Button attributes |
| PLATFORM_BUTTON_CONFIGURATION_t | Button configuration |
| platform_button_catalog | Get platform button configuration |
| platform_button_name | Get platform button name |
| platform_read_button | Read from button |
| LEDs | |
| PLATFORM_LED_ATTRIBUTE_t | LED attributes |
| PLATFORM_LED_CONFIGURATION_t | LED configuration |
| platform_led_catalog | Get platform LED configuration |
| platform_led_name | Get platform LED name |
| platform_write_led | Write to LED |
| Configuration | |
| PLATFORM_PIN_DIRECTION_t | Pin I/O direction |
| PLATFORM_PIN_FEATURE_t | Pin features |
| PLATFORM_PIN_MODE_t | Pin drive mode requirements |
| platform_digital_pin_direction | Get I/O direction |
| platform_digital_pin_drive_strength | Read pin drive strength mode |
| platform_digital_pin_features | Read digital pin features |
| platform_digital_pin_mode | Read digital pin mode |
| platform_digital_pin_speed | Read pin speed |
| platform_set_digital_pin_direction | Set direction for a single digital I/O |
| platform_set_digital_pin_drive_strength | Set drive strength for a single digital I/O |
| platform_set_digital_pin_features | Write features for a single digital I/O |
| platform_set_digital_pin_mode | Set mode for a single digital I/O |
| platform_set_digital_pin_speed | Set speed for a single digital I/O |
| platform_set_multi_digital_pin_drive_strength | Set drive strength for multiple digital I/Os |
| platform_set_multi_digital_pin_mode | Set mode for multiple digital I/Os |
| platform_set_multi_digital_pin_speed | Set speed for multiple digital I/Os |
| Time | |
| platform_cpu_core_frequency | Get CPU core frequency |
| platform_cpu_tick | Get CPU tick |
| platform_cpu_tick_frequency | Get CPU tick frequency |
| platform_spin_delay_cycles | Delay a number of CPU cycles |
| platform_spin_delay_ms | Delay a number of milliseconds |
| platform_spin_delay_us | Delay a number of microseconds |
| Hooks | |
| PLATFORM_EDGE_t | Signal edge require to trigger pin hook |
| PLATFORM_HOOK_t | Platform hook context |
| platform_hook_background | Hook function to background list |
| platform_hook_button_press | Hook a button press |
| platform_hook_pin_edge | Hook function to a pin edge |
| platform_hook_timer | Hook function to a repetitive timer |
| platform_unhook_background | Unhook function from background list |
| platform_unhook_timer | Unhook function from timer |
| I2C | |
| platform_configure_i2c_bus | Configure I2C bus |
| platform_i2c_bus | Get I2C bus interface |
| platform_i2c_bus_pins | Get pins for I2C bus |
| SPI | |
| platform_configure_i2c_bus_ex | Configure I2C bus (extended) |
| platform_configure_spi_bus | Configure SPI bus |
| platform_configure_spi_bus_ex | Configure SPI bus (extended) |
| platform_spi_bus | Get SPI bus interface |
| platform_spi_bus_pins | Get pins for SPI bus |
| UART | |
| platform_configure_uart | Configure UART |
| platform_uart | Get UART interface |
| UEXT | |
| PLATFORM_UEXT_CONFIGURATION_t | UEXT configuration descriptor |
| platform_uext_configuration | Get UEXT configuration descriptor |
| Reset | |
| PLATFORM_RESET_CAUSE_t | Causes of microcontroller reset |
| platform_reboot | Reboot platform |
| platform_reset_cause | Read microcontroller reset cause |
| Watchdog | |
| platform_watchdog_enable | Enable watchdog |
| platform_watchdog_remaining | Inquire remaining watchdog time |
| platform_watchdog_service | Service watchdog |
| platform_watchdog_set_period | Set watchdog timeout period |