MCUXpresso SDK API Reference Manual NXP Semiconductors Document Number: MCUXSDKAPIRM Rev. 0 May 2019 Contents Chapter Introduction Chapter Driver errors status Chapter Architectural Overview Chapter Trademarks Chapter ADC: 12-bit Analog to Digital Converter Driver 5.1 Overview ........................................ 13 5.2 Typical use case .................................... 13 5.2.1 Polling Configuration ................................ 13 5.2.2 Polling Configuration ................................ 13 5.3 Data Structure Documentation ............................ 16 5.3.1 struct adc_config_t.................................. 16 5.3.2 struct adc_offest_config_t.............................. 17 5.3.3 struct adc_hardware_compare_config_t....................... 17 5.3.4 struct adc_channel_config_t............................. 17 5.4 Macro Definition Documentation ........................... 17 5.4.1 FSL_ADC_DRIVER_VERSION.......................... 17 5.5 Enumeration Type Documentation .......................... 18 5.5.1 adc_status_flags_t.................................. 18 5.5.2 adc_reference_voltage_source_t........................... 18 5.5.3 adc_sample_period_mode_t............................. 18 5.5.4 adc_clock_source_t ................................. 18 5.5.5 adc_clock_driver_t.................................. 19 5.5.6 adc_resolution_t................................... 19 5.5.7 adc_hardware_compare_mode_t .......................... 19 5.5.8 adc_hardware_average_mode_t........................... 19 5.6 Function Documentation ............................... 19 5.6.1 ADC_Init....................................... 19 5.6.2 ADC_Deinit..................................... 20 MCUXpresso SDK API Reference Manual NXP Semiconductors iii Section Contents Page Number Title Number 5.6.3 ADC_GetDefaultConfig............................... 20 5.6.4 ADC_SetChannelConfig............................... 20 5.6.5 ADC_GetChannelConversionValue......................... 21 5.6.6 ADC_GetChannelStatusFlags............................ 21 5.6.7 ADC_DoAutoCalibration.............................. 22 5.6.8 ADC_SetOffsetConfig................................ 22 5.6.9 ADC_EnableDMA.................................. 22 5.6.10 ADC_EnableHardwareTrigger ........................... 23 5.6.11 ADC_SetHardwareCompareConfig......................... 23 5.6.12 ADC_SetHardwareAverageConfig ......................... 23 5.6.13 ADC_GetStatusFlags ................................ 24 5.6.14 ADC_ClearStatusFlags ............................... 25 5.7 Variable Documentation ................................ 26 5.7.1 enableOverWrite................................... 26 5.7.2 enableContinuousConversion ............................ 26 5.7.3 enableHighSpeed .................................. 26 5.7.4 enableLowPower................................... 26 5.7.5 enableLongSample.................................. 26 5.7.6 enableAsynchronousClockOutput.......................... 26 5.7.7 referenceVoltageSource ............................... 26 5.7.8 samplePeriodMode ................................. 26 5.7.9 clockSource ..................................... 26 5.7.10 clockDriver...................................... 26 5.7.11 resolution....................................... 26 5.7.12 enableSigned..................................... 26 5.7.13 offsetValue...................................... 26 5.7.14 hardwareCompareMode............................... 26 5.7.15 value1 ........................................ 27 5.7.16 value2 ........................................ 27 5.7.17 channelNumber ................................... 27 5.7.18 enableInterruptOnConversionCompleted ...................... 27 Chapter ADC_ETC: ADC External Trigger Control 6.1 Overview ........................................ 29 6.2 Typical use case .................................... 29 6.2.1 Software trigger Configuration ........................... 29 6.2.2 Hardware trigger Configuration........................... 29 6.3 Data Structure Documentation ............................ 30 6.3.1 struct adc_etc_config_t ............................... 30 6.3.2 struct adc_etc_trigger_chain_config_t........................ 30 6.3.3 struct adc_etc_trigger_config_t ........................... 30 MCUXpresso SDK API Reference Manual iv NXP Semiconductors Section Contents Page Number Title Number 6.4 Macro Definition Documentation ........................... 30 6.4.1 FSL_ADC_ETC_DRIVER_VERSION....................... 30 6.4.2 ADC_ETC_DMA_CTRL_TRGn_REQ_MASK .................. 30 6.5 Function Documentation ............................... 30 6.5.1 ADC_ETC_Init ................................... 30 6.5.2 ADC_ETC_Deinit.................................. 30 Chapter AIPSTZ: AHB to IP Bridge 7.1 Overview ........................................ 33 7.2 Enumeration Type Documentation .......................... 33 7.2.1 aipstz_master_privilege_level_t........................... 33 7.2.2 aipstz_master_t ................................... 34 7.2.3 aipstz_peripheral_access_control_t......................... 34 7.2.4 aipstz_peripheral_t.................................. 34 7.3 Function Documentation ............................... 34 7.3.1 AIPSTZ_SetMasterPriviledgeLevel......................... 34 7.3.2 AIPSTZ_SetPeripheralAccessControl........................ 34 Chapter AOI: Crossbar AND/OR/INVERT Driver 8.1 Overview ........................................ 37 8.2 Function groups .................................... 37 8.2.1 AOI Initialization .................................. 37 8.3 Data Structure Documentation ............................ 39 8.3.1 struct aoi_event_config_t .............................. 39 8.4 Macro Definition Documentation ........................... 39 8.4.1 FSL_AOI_DRIVER_VERSION .......................... 39 8.5 Enumeration Type Documentation .......................... 40 8.5.1 aoi_input_config_t.................................. 40 8.5.2 aoi_event_t...................................... 40 8.6 Function Documentation ............................... 40 8.6.1 AOI_Init....................................... 40 8.6.2 AOI_Deinit ..................................... 40 8.6.3 AOI_GetEventLogicConfig............................. 40 8.6.4 AOI_SetEventLogicConfig ............................. 41 MCUXpresso SDK API Reference Manual NXP Semiconductors v Section Contents Page Number Title Number Chapter BEE: Bus Encryption Engine 9.1 Overview ........................................ 43 9.2 BEE Driver Initialization and Configuration .................... 43 9.3 Enable & Disable BEE ................................ 43 9.4 Set BEE region config and key ............................ 43 9.5 Status .......................................... 44 9.5.1 BEE example..................................... 44 9.6 Data Structure Documentation ............................ 46 9.6.1 struct bee_region_config_t.............................. 46 9.7 Macro Definition Documentation ........................... 46 9.7.1 FSL_BEE_DRIVER_VERSION .......................... 46 9.8 Enumeration Type Documentation .......................... 47 9.8.1 bee_aes_mode_t................................... 47 9.8.2 bee_region_t..................................... 47 9.8.3 bee_ac_prot_enable ................................. 47 9.8.4 bee_endian_swap_enable .............................. 47 9.8.5 bee_security_level.................................. 47 9.8.6 bee_status_flags_t.................................. 48 9.9 Function Documentation ............................... 48 9.9.1 BEE_Init....................................... 48 9.9.2 BEE_Deinit ..................................... 48 9.9.3 BEE_Enable..................................... 48 9.9.4 BEE_Disable..................................... 49 9.9.5 BEE_GetDefaultConfig ............................... 49 9.9.6 BEE_SetConfig ................................... 49 9.9.7 BEE_SetRegionKey................................. 50 9.9.8 BEE_SetRegionNonce................................ 50 9.9.9 BEE_GetStatusFlags................................. 50 9.9.10 BEE_ClearStatusFlags................................ 51 Chapter CACHE: CACHE Memory Controller 10.1 Overview ........................................ 53 10.2 Function groups .................................... 53 10.3 Macro Definition Documentation ........................... 54 10.3.1 FSL_CACHE_DRIVER_VERSION ........................ 54 MCUXpresso SDK API Reference Manual vi NXP Semiconductors Section Contents Page Number Title Number 10.4 Function Documentation ............................... 55 10.4.1 L1CACHE_InvalidateICacheByRange ....................... 55 10.4.2 L1CACHE_InvalidateDCacheByRange....................... 56 10.4.3 L1CACHE_CleanDCacheByRange......................... 56 10.4.4 L1CACHE_CleanInvalidateDCacheByRange.................... 57 10.4.5 ICACHE_InvalidateByRange............................ 58 10.4.6 DCACHE_InvalidateByRange............................ 58 10.4.7 DCACHE_CleanByRange.............................. 59 10.4.8 DCACHE_CleanInvalidateByRange ........................ 60 Chapter CMP: Analog Comparator Driver 11.1 Overview ........................................ 61 11.2 Typical use case .................................... 61 11.2.1 Polling Configuration ................................ 61 11.2.2 Interrupt Configuration ............................... 61 11.3 Data Structure Documentation ............................ 63 11.3.1 struct cmp_config_t ................................. 63 11.3.2 struct cmp_filter_config_t.............................. 63 11.3.3 struct cmp_dac_config_t..............................