### Initializing Documentation Options and Enabling Sphinx Sticky Nav - JavaScript

Source: https://github.com/texasinstruments/c2000ware-core-sdk/blob/main/device_support/f28004x/docs/html/usage.html

This snippet initializes global documentation options for the web application and then activates the sticky navigation feature provided by the 'SphinxRtdTheme' library once the DOM is ready. It sets up basic paths and version information for the documentation system.

```JavaScript
var DOCUMENTATION_OPTIONS = { URL_ROOT:'./', VERSION:'v5.04.00.00', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: false, SOURCELINK_SUFFIX: '.txt' };
jQuery(function () { SphinxRtdTheme.StickyNav.enable(); });
```

--------------------------------

### Define I2C Start Byte Mode Constant in C

Source: https://github.com/texasinstruments/c2000ware-core-sdk/blob/main/device_support/f2837xd/docs/html/modules/i2c.html

Defines a constant to enable the I2C start byte mode. This mode is used for specific communication protocols that utilize a start byte.

```C
#define I2C_START_BYTE_MODE 0x0010U
```

--------------------------------

### Initializing Sphinx RTD Theme and Documentation Options - JavaScript

Source: https://github.com/texasinstruments/c2000ware-core-sdk/blob/main/device_support/f2807x/docs/html/modules/usb.html

This snippet initializes global documentation options for the Sphinx build and enables the sticky navigation feature provided by the Sphinx Read the Docs theme. It sets up paths, version, and other configuration for the documentation site's JavaScript.

```JavaScript
var DOCUMENTATION_OPTIONS = { URL_ROOT:'../', VERSION:'v5.04.00.00', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: false, SOURCELINK_SUFFIX: '.txt' }; jQuery(function () { SphinxRtdTheme.StickyNav.enable(); });
```

--------------------------------

### Define UPP CPU Receive Message RAM Start Address

Source: https://github.com/texasinstruments/c2000ware-core-sdk/blob/main/device_support/f2837xs/docs/html/modules/upp.html

Defines the starting memory address for the UPP CPU receive message RAM.

```C
UPP_CPU_RX_MSGRAM_STARTADDR UPP_RX_MSG_RAM_BASE
```

--------------------------------

### Define UPP CPU Transmit Message RAM Start Address

Source: https://github.com/texasinstruments/c2000ware-core-sdk/blob/main/device_support/f2837xs/docs/html/modules/upp.html

Defines the starting memory address for the UPP CPU transmit message RAM.

```C
UPP_CPU_TX_MSGRAM_STARTADDR UPP_TX_MSG_RAM_BASE
```

--------------------------------

### Initializing Documentation Options and Theme Navigation - JavaScript

Source: https://github.com/texasinstruments/c2000ware-core-sdk/blob/main/device_support/f28002x/docs/html/modules/gpio.html

This snippet initializes global documentation options for the portal, setting parameters such as the root URL, version, and file suffixes. It also enables the sticky navigation feature provided by the Sphinx ReadTheDocs theme, ensuring the sidebar remains visible during scrolling.

```JavaScript
var DOCUMENTATION_OPTIONS = { URL_ROOT:'../', VERSION:'v5.04.00.00', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: false, SOURCELINK_SUFFIX: '.txt' };
jQuery(function () { SphinxRtdTheme.StickyNav.enable(); });
```

--------------------------------

### Initializing Sphinx Documentation Options and Theme

Source: https://github.com/texasinstruments/c2000ware-core-sdk/blob/main/device_support/f2807x/docs/html/usage.html

This snippet defines global configuration options for Sphinx documentation, such as the URL root, version, and file suffixes. It also initializes the Sphinx Read the Docs theme's sticky navigation feature using jQuery.

```JavaScript
var DOCUMENTATION_OPTIONS = { URL_ROOT:'./', VERSION:'v5.04.00.00', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: false, SOURCELINK_SUFFIX: '.txt' }; jQuery(function () { SphinxRtdTheme.StickyNav.enable(); });
```

--------------------------------

### Defining Start of Frame Capture Trigger (C/C++)

Source: https://github.com/texasinstruments/c2000ware-core-sdk/blob/main/device_support/f28p65x/docs/html/modules/escss.html

Defines the ESCSS_SOF_CAPTURE_TRIGGER enumerator, setting the Start of Frame event as a capture trigger within the ESCSS_CaptureTrigger enumeration.

```C/C++
ESCSS_SOF_CAPTURE_TRIGGER = 0U
```

--------------------------------

### Initializing Documentation Options and Sticky Navigation - JavaScript

Source: https://github.com/texasinstruments/c2000ware-core-sdk/blob/main/device_support/f2837xs/docs/html/usage.html

This snippet initializes global JavaScript options for a documentation site, including paths and version information. It also enables the sticky navigation feature provided by the Sphinx Read the Docs theme, ensuring the sidebar remains visible as the user scrolls.

```JavaScript
var DOCUMENTATION_OPTIONS = { URL_ROOT:'./', VERSION:'v5.04.00.00', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: false, SOURCELINK_SUFFIX: '.txt' };
jQuery(function () { SphinxRtdTheme.StickyNav.enable(); });
```

--------------------------------

### Starting CLA Background Task in C

Source: https://github.com/texasinstruments/c2000ware-core-sdk/blob/main/device_support/f28p55x/docs/html/modules/cla.html

This function initiates the background task on the CLA controller. It will only start if no other tasks are currently pending. The base address of the CLA controller is required.

```C
void CLA_startBackgroundTask(uint32_t base)
```

--------------------------------

### Initializing Documentation Options and Theme Navigation - JavaScript

Source: https://github.com/texasinstruments/c2000ware-core-sdk/blob/main/device_support/f280013x/docs/html/usage.html

This snippet initializes global documentation options, including URL roots, version, and file suffixes. It also enables the Sphinx Read the Docs theme's sticky navigation feature, which is crucial for the theme's UI functionality.

```javascript
var DOCUMENTATION_OPTIONS = { URL_ROOT:'./', VERSION:'v5.04.00.00', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: false, SOURCELINK_SUFFIX: '.txt' };
jQuery(function () { SphinxRtdTheme.StickyNav.enable(); });
```

--------------------------------

### Define I2C Start Byte Mode in C

Source: https://github.com/texasinstruments/c2000ware-core-sdk/blob/main/device_support/f28004x/docs/html/modules/i2c.html

Defines the bitmask to enable start byte mode in the I2C module. This mode is used for specific I2C communication protocols.

```C
I2C_START_BYTE_MODE 0x0010U
```

--------------------------------

### Define I2C Start Byte Mode in C

Source: https://github.com/texasinstruments/c2000ware-core-sdk/blob/main/device_support/f28p65x/docs/html/modules/i2c.html

This constant enables the start byte mode for I2C communication. This mode allows for special handling of the first byte transmitted or received.

```C
#define I2C_START_BYTE_MODE 0x0010U
```

--------------------------------

### Initializing SphinxRtdTheme and Documentation Options - JavaScript

Source: https://github.com/texasinstruments/c2000ware-core-sdk/blob/main/device_support/f28002x/docs/html/usage.html

This snippet initializes global documentation options, including URL roots and versioning, and enables the sticky navigation feature of the Sphinx Read the Docs theme using jQuery, ensuring the navigation bar remains visible during scrolling.

```JavaScript
var DOCUMENTATION_OPTIONS = { URL_ROOT:'./', VERSION:'v5.04.00.00', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: false, SOURCELINK_SUFFIX: '.txt' };
jQuery(function () { SphinxRtdTheme.StickyNav.enable(); });
```

--------------------------------

### Defining I2C Slave Interrupt for Start Condition in C/C++

Source: https://github.com/texasinstruments/c2000ware-core-sdk/blob/main/device_support/f2838x/docs/html_cm/modules/i2c.html

This constant represents the interrupt flag for the detection of an I2C Start Condition, signaling the beginning of a new communication transaction.

```C/C++
#define I2C_SLAVE_INT_START 0x00000002U
```

--------------------------------

### Initializing Sphinx Documentation Options and Sticky Navigation (JavaScript)

Source: https://github.com/texasinstruments/c2000ware-core-sdk/blob/main/device_support/f2837xd/docs/html/usage.html

This snippet defines global configuration options for Sphinx documentation, such as URL root, version, and file suffixes. It then uses jQuery to enable the sticky navigation feature provided by the Sphinx Read the Docs theme, typically executed once the DOM is ready.

```JavaScript
var DOCUMENTATION_OPTIONS = { URL_ROOT:'./', VERSION:'v5.04.00.00', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: false, SOURCELINK_SUFFIX: '.txt' }; jQuery(function () { SphinxRtdTheme.StickyNav.enable(); });
```

--------------------------------

### Sending I2C Start Condition in C

Source: https://github.com/texasinstruments/c2000ware-core-sdk/blob/main/device_support/f2838x/docs/html/modules/i2c.html

This function generates an I2C START condition. It is only valid when the I2C module is configured as a controller. The function requires the base address of the I2C instance.

```C
void I2C_sendStartCondition(uint32_t base)
```

--------------------------------

### Initializing Sphinx Documentation Options and Theme

Source: https://github.com/texasinstruments/c2000ware-core-sdk/blob/main/device_support/f2838x/docs/html/usage.html

This snippet initializes global JavaScript options for Sphinx documentation, including URL roots, version, and file suffixes. It also enables the sticky navigation feature provided by the Sphinx Read the Docs theme upon document readiness.

```JavaScript
var DOCUMENTATION_OPTIONS = { URL_ROOT:'./', VERSION:'v5.04.00.00', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: false, SOURCELINK_SUFFIX: '.txt' };
jQuery(function () { SphinxRtdTheme.StickyNav.enable(); });
```

--------------------------------

### Starting ECAP Time Stamp Counter (C)

Source: https://github.com/texasinstruments/c2000ware-core-sdk/blob/main/device_support/f28004x/docs/html/modules/ecap.html

This function starts the time stamp counter of the ECAP module. It requires the base address of the ECAP module as input. No value is returned.

```C
void ECAP_startCounter(uint32_t _base_)
```

--------------------------------

### Loading Search Index for Documentation in JavaScript

Source: https://github.com/texasinstruments/c2000ware-core-sdk/blob/main/docs/c2000Ware_quickstart_guide/html/search.html

This snippet initiates the loading of the search index file ('searchindex.js') for the documentation. This index is essential for enabling the client-side search functionality, allowing users to query the documentation content efficiently.

```JavaScript
jQuery(function() { Search.loadIndex("searchindex.js"); });
```

--------------------------------

### Sending I2C START Condition in C

Source: https://github.com/texasinstruments/c2000ware-core-sdk/blob/main/device_support/f28p65x/docs/html/modules/i2c.html

This function generates an I2C START condition on the bus. It is only valid when the I2C module is configured as a controller. The function requires the base address of the I2C instance.

```C
void I2C_sendStartCondition(uint32_t base)
```

--------------------------------

### Initializing Documentation Options and Sticky Navigation (JavaScript)

Source: https://github.com/texasinstruments/c2000ware-core-sdk/blob/main/docs/c2000Ware_quickstart_guide/html/package.html

This snippet defines global configuration options for documentation and immediately enables the sticky navigation feature provided by the Sphinx Read the Docs theme upon document load. It sets up basic parameters for the documentation environment.

```JavaScript
var DOCUMENTATION_OPTIONS = { URL_ROOT:'./', VERSION:'v1.0.0', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: true, SOURCELINK_SUFFIX: '.txt' };
jQuery(function () { SphinxRtdTheme.StickyNav.enable(); });
```

--------------------------------

### Initializing Documentation Options and Sticky Navigation - JavaScript

Source: https://github.com/texasinstruments/c2000ware-core-sdk/blob/main/device_support/f28p55x/docs/html/usage.html

This snippet initializes global documentation options, including URL root, version, and file suffixes. It also enables the Sphinx Read the Docs theme's sticky navigation feature upon document readiness, ensuring the navigation bar remains visible while scrolling.

```JavaScript
var DOCUMENTATION_OPTIONS = { URL_ROOT:'./', VERSION:'v5.04.00.00', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: false, SOURCELINK_SUFFIX: '.txt' }; jQuery(function () { SphinxRtdTheme.StickyNav.enable(); });
```

--------------------------------

### Starting CPU Timer in C

Source: https://github.com/texasinstruments/c2000ware-core-sdk/blob/main/device_support/f28p65x/docs/html/modules/cputimer.html

This function starts or restarts the CPU timer, reloading its counter with the period value. It requires the base address of the timer module as input. No value is returned.

```C
void CPUTimer_startTimer(uint32_t base)
```

--------------------------------

### Initializing Documentation Options and Theme Navigation (JavaScript)

Source: https://github.com/texasinstruments/c2000ware-core-sdk/blob/main/device_support/f280013x/docs/html/modules/epg.html

This snippet defines global configuration options for the documentation, including root URL, version, and file suffixes. It then enables the sticky navigation feature provided by the Sphinx Read the Docs theme upon document load, ensuring the sidebar remains visible during scrolling.

```JavaScript
var DOCUMENTATION_OPTIONS = { URL_ROOT:'../', VERSION:'v5.04.00.00', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: false, SOURCELINK_SUFFIX: '.txt' }; jQuery(function () { SphinxRtdTheme.StickyNav.enable(); });
```

--------------------------------

### Starting CPU Timer (C/C++)

Source: https://github.com/texasinstruments/c2000ware-core-sdk/blob/main/device_support/f2837xs/docs/html/modules/cputimer.html

This function starts (restarts) the CPU timer. It takes the base address of the timer module. Note that this function reloads the timer counter. It returns nothing.

```C/C++
void CPUTimer_startTimer(uint32_t _base_)
```

--------------------------------

### Getting Interrupt Cause from CAN Controller (C/C++)

Source: https://github.com/texasinstruments/c2000ware-core-sdk/blob/main/device_support/f2837xs/docs/html/modules/can.html

Gets the CAN controller interrupt cause. This function returns the value of the interrupt register that indicates the cause of the interrupt. The 'base' parameter specifies the base address of the CAN controller.

```C
uint32_t CAN_getInterruptCause(uint32_t base)
```

--------------------------------

### Initializing Documentation Options and Theme Navigation - JavaScript

Source: https://github.com/texasinstruments/c2000ware-core-sdk/blob/main/device_support/f2837xs/docs/html/modules/upp.html

This snippet initializes global documentation options, including paths and version information. It then enables the sticky navigation feature provided by the Sphinx ReadTheDocs theme, ensuring the navigation bar remains visible as the user scrolls.

```javascript
var DOCUMENTATION_OPTIONS = { URL_ROOT:'../', VERSION:'v5.04.00.00', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: false, SOURCELINK_SUFFIX: '.txt' }; jQuery(function () { SphinxRtdTheme.StickyNav.enable(); });
```

--------------------------------

### Initializing Sphinx Documentation Options and Sticky Navigation (JavaScript)

Source: https://github.com/texasinstruments/c2000ware-core-sdk/blob/main/device_support/f28p65x/docs/html/modules/eqep.html

This snippet initializes global documentation options, including paths, version, and file suffixes. It then uses jQuery to enable the 'StickyNav' feature of the 'SphinxRtdTheme' once the DOM is ready, ensuring the navigation bar remains visible during scrolling.

```JavaScript
var DOCUMENTATION_OPTIONS = { URL_ROOT:'../', VERSION:'v5.02.00.00', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: false, SOURCELINK_SUFFIX: '.txt' };
jQuery(function () { SphinxRtdTheme.StickyNav.enable(); });
```

--------------------------------

### Sending I2C Start Condition (C)

Source: https://github.com/texasinstruments/c2000ware-core-sdk/blob/main/device_support/f28003x/docs/html/modules/i2c.html

This function commands the I2C module to generate a START condition on the bus. This operation is only valid when the I2C module, specified by its base address, is configured as a controller.

```C
void I2C_sendStartCondition(uint32_t base)
```

--------------------------------

### Initializing Sphinx Documentation Options - JavaScript

Source: https://github.com/texasinstruments/c2000ware-core-sdk/blob/main/device_support/f28002x/docs/html/search.html

This snippet initializes the DOCUMENTATION_OPTIONS object, which configures various settings for a Sphinx-generated documentation site. It defines paths, version, file suffixes, and source link behavior, crucial for navigation and content loading.

```JavaScript
var DOCUMENTATION_OPTIONS = { URL_ROOT:'./', VERSION:'v5.04.00.00', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', LINK_SUFFIX: '.html', HAS_SOURCE: false, SOURCELINK_SUFFIX: '.txt' };
```

--------------------------------

### Getting Modulator Status - SDFM - C/C++

Source: https://github.com/texasinstruments/c2000ware-core-sdk/blob/main/device_support/f28003x/docs/html/modules/sdfm.html

This function returns the Modulator status.

```C/C++
bool SDFM_getModulatorStatus(uint32_t base, SDFM_FilterNumber filterNumber)
```

--------------------------------

### Getting Device Part ID in DCSM (C/C++)

Source: https://github.com/texasinstruments/c2000ware-core-sdk/blob/main/device_support/f28p65x/docs/html/modules/dcsm.html

Retrieves the device's PARTIDH value.

```C/C++
uint32_t DCSM_getDevicePartID(void)
```

--------------------------------

### Configuring Documentation Options (JavaScript)

Source: https://github.com/texasinstruments/c2000ware-core-sdk/blob/main/device_support/f280013x/docs/html/search.html

This snippet initializes a global JavaScript object `DOCUMENTATION_OPTIONS` which defines various configuration parameters for the documentation, such as root URL, version, file suffixes, and source link behavior. These options are crucial for the proper rendering and navigation of the API guide.

```JavaScript
var DOCUMENTATION_OPTIONS = { URL_ROOT:'./', VERSION:'v5.04.00.00', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', LINK_SUFFIX: '.html', HAS_SOURCE: false, SOURCELINK_SUFFIX: '.txt' };
```

--------------------------------

### Initializing Sphinx Documentation Options and Theme - JavaScript

Source: https://github.com/texasinstruments/c2000ware-core-sdk/blob/main/device_support/f2838x/docs/html_cm/usage.html

This snippet defines global configuration options for a Sphinx documentation site, such as URL root, version, and file suffixes. It also initializes the `SphinxRtdTheme.StickyNav` component, enabling its sticky navigation functionality upon document load using jQuery.

```JavaScript
var DOCUMENTATION_OPTIONS = { URL_ROOT:'./', VERSION:'v5.04.00.00', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: false, SOURCELINK_SUFFIX: '.txt' };
jQuery(function () { SphinxRtdTheme.StickyNav.enable(); });
```

--------------------------------

### Define ADC_PPBxCOUNT_OFFSET_BASE

Source: https://github.com/texasinstruments/c2000ware-core-sdk/blob/main/device_support/f28p55x/docs/html/modules/adc.html

Specifies the base offset for the PPB count registers, starting from PPB1COUNT.

```C
ADC_PPBxCOUNT_OFFSET_BASE ADC_O_PPB1COUNT
```

--------------------------------

### Configuring Documentation Options - JavaScript

Source: https://github.com/texasinstruments/c2000ware-core-sdk/blob/main/device_support/f28p65x/docs/html/search.html

Initializes global documentation options used by the Sphinx documentation theme. These options define paths, versioning, and file handling for the documentation system.

```JavaScript
var DOCUMENTATION_OPTIONS = { URL_ROOT:'./', VERSION:'v5.02.00.00', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', LINK_SUFFIX: '.html', HAS_SOURCE: false, SOURCELINK_SUFFIX: '.txt' };
```

--------------------------------

### Define ADC_PPBxSUM_OFFSET_BASE

Source: https://github.com/texasinstruments/c2000ware-core-sdk/blob/main/device_support/f28p55x/docs/html/modules/adc.html

Specifies the base offset for the PPB sum registers, starting from PPB1SUM.

```C
ADC_PPBxSUM_OFFSET_BASE ADC_O_PPB1SUM
```

--------------------------------

### Initializing Sphinx Documentation Options and Theme

Source: https://github.com/texasinstruments/c2000ware-core-sdk/blob/main/device_support/f28004x/docs/html/modules/spi.html

This snippet defines global configuration options for the Sphinx documentation, including root URL, version, and file suffixes. It also initializes the Sphinx ReadTheDocs theme's sticky navigation feature upon document readiness.

```JavaScript
var DOCUMENTATION_OPTIONS = { URL_ROOT:'../', VERSION:'v5.04.00.00', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: false, SOURCELINK_SUFFIX: '.txt' };
jQuery(function () { SphinxRtdTheme.StickyNav.enable(); });
```

--------------------------------

### Define ADC_PPBxMIN_OFFSET_BASE

Source: https://github.com/texasinstruments/c2000ware-core-sdk/blob/main/device_support/f28p55x/docs/html/modules/adc.html

Specifies the base offset for the PPB minimum registers, starting from PPB1MIN.

```C
ADC_PPBxMIN_OFFSET_BASE ADC_O_PPB1MIN
```

--------------------------------

### Initializing Documentation Options and Managing Sticky Navigation in JavaScript

Source: https://github.com/texasinstruments/c2000ware-core-sdk/blob/main/docs/c2000Ware_quickstart_guide/html/updatec2000ware.html

This JavaScript snippet initializes global documentation options, enables sticky navigation using SphinxRtdTheme.StickyNav, and implements custom scroll behavior for the navigation sidebar. It also overrides default mousewheel scrolling to provide a smoother, non-smoothed scroll experience for the documentation.

```JavaScript
var DOCUMENTATION_OPTIONS = { URL_ROOT:'./', VERSION:'v1.0.0', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: true, SOURCELINK_SUFFIX: '.txt' }; jQuery(function () { SphinxRtdTheme.StickyNav.enable(); }); var menuHeight = window.innerHeight; var contentOffset = $(".wy-nav-content-wrap").offset(); var contentHeight = $(".wy-nav-content-wrap").height(); var contentBottom = contentOffset.top + contentHeight; function setNavbarTop() { var scrollTop = $(window).scrollTop(); var maxTop = scrollTop - contentOffset.top; // If past the header if (scrollTop > contentOffset.top && maxTop < contentBottom) { stickyTop = scrollTop - contentOffset.top; } else if (maxTop > contentBottom) { stickyTop = scrollTop - contentOffset.top - (maxTop - contentBottom); } else { stickyTop = 0; } $(".wy-nav-side").css("top", stickyTop); } $(document).ready(function() { setNavbarTop(); $(window).scroll(function () { setNavbarTop(); }); $('body').on("mousewheel", function () { // Remove default behavior event.preventDefault(); // Scroll without smoothing var wheelDelta = event.wheelDelta; var currentScrollPosition = window.pageYOffset; window.scrollTo(0, currentScrollPosition - wheelDelta); }); });
```

--------------------------------

### Define ADC_PPBxMAX_OFFSET_BASE

Source: https://github.com/texasinstruments/c2000ware-core-sdk/blob/main/device_support/f28p55x/docs/html/modules/adc.html

Specifies the base offset for the PPB maximum registers, starting from PPB1MAX.

```C
ADC_PPBxMAX_OFFSET_BASE ADC_O_PPB1MAX
```

--------------------------------

### Define ADC_PPBxLIMIT_OFFSET_BASE

Source: https://github.com/texasinstruments/c2000ware-core-sdk/blob/main/device_support/f28p55x/docs/html/modules/adc.html

Specifies the base offset for the PPB limit registers, starting from PPB1LIMIT.

```C
ADC_PPBxLIMIT_OFFSET_BASE ADC_O_PPB1LIMIT
```

--------------------------------

### Initializing Documentation Options and Enabling Sticky Navigation (JavaScript)

Source: https://github.com/texasinstruments/c2000ware-core-sdk/blob/main/device_support/f280015x/docs/html/usage.html

This snippet initializes global documentation options used by Sphinx and enables the sticky navigation feature provided by the Sphinx ReadTheDocs theme. It ensures the navigation bar remains fixed or 'sticky' as the user scrolls.

```JavaScript
var DOCUMENTATION_OPTIONS = { URL_ROOT:'./', VERSION:'v5.04.00.00', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: false, SOURCELINK_SUFFIX: '.txt' };
jQuery(function () { SphinxRtdTheme.StickyNav.enable(); });
```

--------------------------------

### Initializing Sphinx Documentation Options - JavaScript

Source: https://github.com/texasinstruments/c2000ware-core-sdk/blob/main/device_support/f28003x/docs/html/modules/eqep.html

This snippet initializes a global JavaScript object, `DOCUMENTATION_OPTIONS`, which holds configuration parameters for a Sphinx-generated documentation site. These options include the root URL, version, index collapse setting, file suffix, and source link suffix, guiding how the documentation behaves and links.

```JavaScript
var DOCUMENTATION_OPTIONS = { URL_ROOT:'../', VERSION:'v5.04.00.00', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: false, SOURCELINK_SUFFIX: '.txt' };
```

--------------------------------

### Define ADC_PPBxPMIN_OFFSET_BASE

Source: https://github.com/texasinstruments/c2000ware-core-sdk/blob/main/device_support/f28p55x/docs/html/modules/adc.html

Specifies the base offset for the PPB pre-minimum registers, starting from PPB1PMIN.

```C
ADC_PPBxPMIN_OFFSET_BASE ADC_O_PPB1PMIN
```

--------------------------------

### Initializing Documentation Options - JavaScript

Source: https://github.com/texasinstruments/c2000ware-core-sdk/blob/main/device_support/f28003x/docs/html/modules/epg.html

This snippet initializes a global JavaScript object `DOCUMENTATION_OPTIONS` which configures various parameters for the documentation system, such as root URL, version, file suffixes, and source link behavior. It's crucial for the proper functioning of the documentation's navigation and linking.

```JavaScript
var DOCUMENTATION_OPTIONS = { URL_ROOT:'../', VERSION:'v5.04.00.00', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: false, SOURCELINK_SUFFIX: '.txt' };
```

--------------------------------

### Define ADC_PPBxPMAX_OFFSET_BASE

Source: https://github.com/texasinstruments/c2000ware-core-sdk/blob/main/device_support/f28p55x/docs/html/modules/adc.html

Specifies the base offset for the PPB pre-maximum registers, starting from PPB1PMAX.

```C
ADC_PPBxPMAX_OFFSET_BASE ADC_O_PPB1PMAX
```

--------------------------------

### Initializing Documentation Options and Sticky Navigation (JavaScript)

Source: https://github.com/texasinstruments/c2000ware-core-sdk/blob/main/device_support/f280015x/docs/html/modules/flash.html

This snippet initializes global documentation configuration options, such as root URL, version, and file suffixes. It then uses jQuery's ready function to enable the 'StickyNav' feature provided by 'SphinxRtdTheme', which likely manages the behavior of a sticky navigation element.

```JavaScript
var DOCUMENTATION_OPTIONS = { URL_ROOT:'../', VERSION:'v5.04.00.00', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: false, SOURCELINK_SUFFIX: '.txt' }; jQuery(function () { SphinxRtdTheme.StickyNav.enable(); });
```

--------------------------------

### Define ADC_PPBxPCOUNT_OFFSET_BASE

Source: https://github.com/texasinstruments/c2000ware-core-sdk/blob/main/device_support/f28p55x/docs/html/modules/adc.html

Specifies the base offset for the PPB pre-count registers, starting from PPBP1PCOUNT.

```C
ADC_PPBxPCOUNT_OFFSET_BASE ADC_O_PPBP1PCOUNT
```

--------------------------------

### Define ADC_PPBxPSUM_OFFSET_BASE

Source: https://github.com/texasinstruments/c2000ware-core-sdk/blob/main/device_support/f28p55x/docs/html/modules/adc.html

Specifies the base offset for the PPB pre-sum registers, starting from PPB1PSUM.

```C
ADC_PPBxPSUM_OFFSET_BASE ADC_O_PPB1PSUM
```

--------------------------------

### Initializing Sphinx RTD Theme and Documentation Options (JavaScript)

Source: https://github.com/texasinstruments/c2000ware-core-sdk/blob/main/device_support/f2838x/docs/html/modules/sdfm.html

This snippet initializes global documentation options and enables the sticky navigation feature provided by the Sphinx Read the Docs theme. It sets parameters like the root URL, version, file suffixes, and source link behavior, which are crucial for the documentation's functionality and appearance.

```JavaScript
var DOCUMENTATION_OPTIONS = { URL_ROOT:'../', VERSION:'v5.04.00.00', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: false, SOURCELINK_SUFFIX: '.txt' };
jQuery(function () { SphinxRtdTheme.StickyNav.enable(); });
```

--------------------------------

### Initializing Documentation Options - JavaScript

Source: https://github.com/texasinstruments/c2000ware-core-sdk/blob/main/device_support/f28p65x/docs/html/index.html

This snippet initializes a global JavaScript object `DOCUMENTATION_OPTIONS` which configures various parameters for a documentation viewer, likely Sphinx-based. It defines paths, version, and display settings for documentation files.

```JavaScript
var DOCUMENTATION_OPTIONS = { URL_ROOT:'./', VERSION:'v5.02.00.00', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: false, SOURCELINK_SUFFIX: '.txt' };
```

--------------------------------

### Define ADC_INTSELxNy_OFFSET_BASE

Source: https://github.com/texasinstruments/c2000ware-core-sdk/blob/main/device_support/f28p55x/docs/html/modules/adc.html

Specifies the base offset for the interrupt selection registers, starting from INTSEL1N2.

```C
ADC_INTSELxNy_OFFSET_BASE ADC_O_INTSEL1N2
```

--------------------------------

### Define ADC_PPBxMINI_OFFSET_BASE

Source: https://github.com/texasinstruments/c2000ware-core-sdk/blob/main/device_support/f28p55x/docs/html/modules/adc.html

Specifies the base offset for the PPB minimum index registers, starting from PPB1MINI.

```C
ADC_PPBxMINI_OFFSET_BASE ADC_O_PPB1MINI
```

--------------------------------

### Initializing Sphinx Documentation Options and Theme Navigation (JavaScript)

Source: https://github.com/texasinstruments/c2000ware-core-sdk/blob/main/device_support/f28003x/docs/html/modules/dcc.html

This snippet initializes global documentation options for a Sphinx-generated site, including paths and version information. It then enables the sticky navigation feature provided by the SphinxRtdTheme using jQuery's document ready function.

```JavaScript
var DOCUMENTATION_OPTIONS = { URL_ROOT:'../', VERSION:'v5.04.00.00', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: false, SOURCELINK_SUFFIX: '.txt' };
jQuery(function () { SphinxRtdTheme.StickyNav.enable(); });
```

--------------------------------

### Define ADC_PPBxMAXI_OFFSET_BASE

Source: https://github.com/texasinstruments/c2000ware-core-sdk/blob/main/device_support/f28p55x/docs/html/modules/adc.html

Specifies the base offset for the PPB maximum index registers, starting from PPB1MAXI.

```C
ADC_PPBxMAXI_OFFSET_BASE ADC_O_PPB1MAXI
```

--------------------------------

### Initializing Documentation Options and Sticky Navigation (JavaScript)

Source: https://github.com/texasinstruments/c2000ware-core-sdk/blob/main/device_support/f28p55x/docs/html/index.html

This snippet initializes global documentation options, setting parameters like the URL root, version, and file suffixes. It then enables the sticky navigation feature provided by the Sphinx ReadTheDocs theme, ensuring the navigation bar remains visible as the user scrolls.

```JavaScript
var DOCUMENTATION_OPTIONS = { URL_ROOT:'./', VERSION:'v5.04.00.00', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: false, SOURCELINK_SUFFIX: '.txt' }; jQuery(function () { SphinxRtdTheme.StickyNav.enable(); });
```

--------------------------------

### Define ADC_PPBxPMINI_OFFSET_BASE

Source: https://github.com/texasinstruments/c2000ware-core-sdk/blob/main/device_support/f28p55x/docs/html/modules/adc.html

Specifies the base offset for the PPB pre-minimum index registers, starting from PPB1PMINI.

```C
ADC_PPBxPMINI_OFFSET_BASE ADC_O_PPB1PMINI
```

--------------------------------

### Initializing Documentation Options and Theme - JavaScript

Source: https://github.com/texasinstruments/c2000ware-core-sdk/blob/main/device_support/f280013x/docs/html/modules/dcc.html

This snippet defines global documentation options for a Sphinx-generated site and initializes the Sphinx ReadTheDocs theme's sticky navigation feature. It sets parameters like URL root, version, and file suffixes, which are crucial for the documentation's functionality and appearance.

```javascript
var DOCUMENTATION_OPTIONS = { URL_ROOT:'../', VERSION:'v5.04.00.00', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: false, SOURCELINK_SUFFIX: '.txt' };
jQuery(function () {
  SphinxRtdTheme.StickyNav.enable();
});
```

--------------------------------

### Initializing Documentation Options and Sticky Navigation with jQuery

Source: https://github.com/texasinstruments/c2000ware-core-sdk/blob/main/device_support/f28p65x/docs/html/modules/dcsm.html

This snippet initializes global documentation options and enables a sticky navigation feature using the Sphinx Read the Docs theme and jQuery. It sets parameters like URL root, version, and file suffixes for documentation generation.

```javascript
var DOCUMENTATION_OPTIONS = { URL_ROOT:'../', VERSION:'v5.02.00.00', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: false, SOURCELINK_SUFFIX: '.txt' };
jQuery(function () { SphinxRtdTheme.StickyNav.enable(); });
```

--------------------------------

### Define ADC_PPBxPMAXI_OFFSET_BASE

Source: https://github.com/texasinstruments/c2000ware-core-sdk/blob/main/device_support/f28p55x/docs/html/modules/adc.html

Specifies the base offset for the PPB pre-maximum index registers, starting from PPB1PMAXI.

```C
ADC_PPBxPMAXI_OFFSET_BASE ADC_O_PPB1PMAXI
```

--------------------------------

### Define ADC_RESULTx_OFFSET_BASE

Source: https://github.com/texasinstruments/c2000ware-core-sdk/blob/main/device_support/f28p55x/docs/html/modules/adc.html

Specifies the base offset for the ADC conversion result registers, starting from RESULT0.

```C
ADC_RESULTx_OFFSET_BASE ADC_O_RESULT0
```

--------------------------------

### Initializing Documentation Options - JavaScript

Source: https://github.com/texasinstruments/c2000ware-core-sdk/blob/main/device_support/f28002x/docs/html/modules/spi.html

This snippet initializes a global JavaScript object, `DOCUMENTATION_OPTIONS`, which holds configuration settings for the documentation system. These options include the root URL, version number, and file suffixes for documentation pages and source links.

```JavaScript
var DOCUMENTATION_OPTIONS = { URL_ROOT:'../', VERSION:'v5.04.00.00', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: false, SOURCELINK_SUFFIX: '.txt' };
```

--------------------------------

### Configuring Documentation Options - JavaScript

Source: https://github.com/texasinstruments/c2000ware-core-sdk/blob/main/device_support/f2838x/docs/html_cm/modules/memcfg.html

This snippet initializes a global JavaScript object, `DOCUMENTATION_OPTIONS`, which holds configuration parameters for a documentation theme or system. It defines paths, version, and display settings.

```JavaScript
var DOCUMENTATION_OPTIONS = { URL_ROOT:'../', VERSION:'v5.04.00.00', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: false, SOURCELINK_SUFFIX: '.txt' };
```

--------------------------------

### Define ADC_SOCxCTL_OFFSET_BASE

Source: https://github.com/texasinstruments/c2000ware-core-sdk/blob/main/device_support/f28p55x/docs/html/modules/adc.html

Specifies the base offset for the Start-of-Conversion (SOC) control registers, starting from SOC0CTL.

```C
ADC_SOCxCTL_OFFSET_BASE ADC_O_SOC0CTL
```

--------------------------------

### Initializing Documentation Options and Sticky Navigation (JavaScript)

Source: https://github.com/texasinstruments/c2000ware-core-sdk/blob/main/device_support/f2838x/docs/html_cm/modules/udma.html

This snippet initializes global documentation options for a Sphinx-generated site, defining paths, version, and file suffixes. It also enables the sticky navigation feature provided by the Sphinx ReadTheDocs theme upon document readiness.

```javascript
var DOCUMENTATION_OPTIONS = { URL_ROOT:'../', VERSION:'v5.04.00.00', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: false, SOURCELINK_SUFFIX: '.txt' };
jQuery(function () { SphinxRtdTheme.StickyNav.enable(); });
```

--------------------------------

### Getting Pending Interrupt Status - SDFM - C/C++

Source: https://github.com/texasinstruments/c2000ware-core-sdk/blob/main/device_support/f28003x/docs/html/modules/sdfm.html

This function returns any pending interrupt status.

```C/C++
bool SDFM_getIsrStatus(uint32_t base)
```

--------------------------------

### Configuring Documentation Options and Activating Sticky Navigation (JavaScript)

Source: https://github.com/texasinstruments/c2000ware-core-sdk/blob/main/device_support/f280013x/docs/html/modules/spi.html

This snippet defines global documentation options, including root URL, version, and file suffixes. It then uses jQuery to enable the sticky navigation feature of the Sphinx Read the Docs theme once the DOM is ready.

```JavaScript
var DOCUMENTATION_OPTIONS = { URL_ROOT:'../', VERSION:'v5.04.00.00', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: false, SOURCELINK_SUFFIX: '.txt' };
jQuery(function () { SphinxRtdTheme.StickyNav.enable(); });
```

--------------------------------

### Getting Peripheral Semaphore Status in DCSM (C/C++)

Source: https://github.com/texasinstruments/c2000ware-core-sdk/blob/main/device_support/f28p65x/docs/html/modules/dcsm.html

Retrieves the current value of the Flash wrapper semaphore register.

```C/C++
uint32_t DCSM_getPerSemStatus(DCSM_PERSem _grabType_)
```

--------------------------------

### Defining Documentation Options - JavaScript

Source: https://github.com/texasinstruments/c2000ware-core-sdk/blob/main/device_support/f2837xd/docs/html/search.html

This snippet defines global configuration options for the documentation system, including root URL, version, file suffixes, and source link settings. These options are crucial for the proper rendering and navigation of the documentation.

```JavaScript
var DOCUMENTATION_OPTIONS = { URL_ROOT:'./', VERSION:'v5.04.00.00', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', LINK_SUFFIX: '.html', HAS_SOURCE: false, SOURCELINK_SUFFIX: '.txt' };
```

--------------------------------

### Define ADC_PPBxRESULT_OFFSET_BASE

Source: https://github.com/texasinstruments/c2000ware-core-sdk/blob/main/device_support/f28p55x/docs/html/modules/adc.html

Specifies the base offset for the Post-Processing Block (PPB) result registers, starting from PPB1RESULT.

```C
ADC_PPBxRESULT_OFFSET_BASE ADC_O_PPB1RESULT
```

--------------------------------

### Define MCBSP_ERROR_2_PARTITION_A Constant - C

Source: https://github.com/texasinstruments/c2000ware-core-sdk/blob/main/device_support/f2838x/docs/html/modules/mcbsp.html

Represents an error code related to the setup of partition A in a 2-partition configuration.

```C
MCBSP_ERROR_2_PARTITION_A 0x2U
```

--------------------------------

### Initializing Documentation Options and Sticky Navigation (JavaScript)

Source: https://github.com/texasinstruments/c2000ware-core-sdk/blob/main/device_support/f280015x/docs/html/search.html

This snippet initializes global documentation options used by Sphinx, such as URL roots, version, and file suffixes. It then enables the sticky navigation feature provided by the Sphinx ReadTheDocs theme, ensuring the navigation bar remains visible during scrolling.

```JavaScript
var DOCUMENTATION_OPTIONS = { URL_ROOT:'./', VERSION:'v5.04.00.00', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', LINK_SUFFIX: '.html', HAS_SOURCE: false, SOURCELINK_SUFFIX: '.txt' }; jQuery(function () { SphinxRtdTheme.StickyNav.enable(); });
```

--------------------------------

### Initializing Sphinx Documentation Options and Theme

Source: https://github.com/texasinstruments/c2000ware-core-sdk/blob/main/device_support/f2838x/docs/html/modules/spi.html

This snippet defines global configuration options for Sphinx documentation and initializes the sticky navigation feature of the Sphinx ReadTheDocs theme upon document load. It sets parameters like URL root, version, and file suffixes.

```JavaScript
var DOCUMENTATION_OPTIONS = { URL_ROOT:'../', VERSION:'v5.04.00.00', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: false, SOURCELINK_SUFFIX: '.txt' };
jQuery(function () { SphinxRtdTheme.StickyNav.enable(); });
```

--------------------------------

### Define MCBSP_ERROR_2_PARTITION_B Constant - C

Source: https://github.com/texasinstruments/c2000ware-core-sdk/blob/main/device_support/f2838x/docs/html/modules/mcbsp.html

Represents an error code related to the setup of partition B in a 2-partition configuration.

```C
MCBSP_ERROR_2_PARTITION_B 0x4U
```

--------------------------------

### MCAN Configuration Parameters Structure (C/C++)

Source: https://github.com/texasinstruments/c2000ware-core-sdk/blob/main/device_support/f28p55x/docs/html/modules/mcan.html

This structure defines general configuration parameters for the MCAN module, used during its setup.

```C/C++
struct MCAN_ConfigParams
```

--------------------------------

### Initializing Documentation Options and Sticky Navigation in JavaScript

Source: https://github.com/texasinstruments/c2000ware-core-sdk/blob/main/device_support/f280013x/docs/html/modules/gpio.html

This snippet initializes global documentation options, including paths, version, and file suffixes. It then enables the Sphinx Read the Docs theme's sticky navigation feature using jQuery, ensuring the navigation bar remains visible while scrolling.

```JavaScript
var DOCUMENTATION_OPTIONS = { URL_ROOT:'../', VERSION:'v5.04.00.00', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: false, SOURCELINK_SUFFIX: '.txt' };
jQuery(function () { SphinxRtdTheme.StickyNav.enable(); });
```

--------------------------------

### MCAN Initialization Parameters Structure (C/C++)

Source: https://github.com/texasinstruments/c2000ware-core-sdk/blob/main/device_support/f28p55x/docs/html/modules/mcan.html

This structure contains parameters required for the initial setup and configuration of the MCAN module.

```C/C++
struct MCAN_InitParams
```

--------------------------------

### Initializing Documentation Options - JavaScript

Source: https://github.com/texasinstruments/c2000ware-core-sdk/blob/main/device_support/f28003x/docs/html/usage.html

This snippet initializes a global JavaScript object `DOCUMENTATION_OPTIONS` which configures various parameters for the documentation system, such as URL root, version, file suffixes, and source link settings. It's used by the Sphinx documentation theme to control navigation and linking behavior.

```JavaScript
var DOCUMENTATION_OPTIONS = { URL_ROOT:'./', VERSION:'v5.04.00.00', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: false, SOURCELINK_SUFFIX: '.txt' };
```

--------------------------------

### Configuring Documentation Options and Initializing Sticky Navigation (JavaScript)

Source: https://github.com/texasinstruments/c2000ware-core-sdk/blob/main/device_support/f28002x/docs/html/modules/dcc.html

This snippet defines global configuration options for the documentation, such as the root URL, version, and file suffixes. It also uses jQuery to enable the sticky navigation feature provided by the Sphinx ReadTheDocs theme once the DOM is ready.

```JavaScript
var DOCUMENTATION_OPTIONS = { URL_ROOT:'../', VERSION:'v5.04.00.00', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: false, SOURCELINK_SUFFIX: '.txt' };
jQuery(function () { SphinxRtdTheme.StickyNav.enable(); });
```

--------------------------------

### Getting Comparator Threshold Status - SDFM - C/C++

Source: https://github.com/texasinstruments/c2000ware-core-sdk/blob/main/device_support/f28003x/docs/html/modules/sdfm.html

This function returns the Comparator output threshold status for the given filterNumber.

```C/C++
SDFM_OutputThresholdStatus SDFM_getThresholdStatus(uint32_t base, SDFM_FilterNumber filterNumber)
```

--------------------------------

### Initializing Documentation Options and Sticky Navigation (JavaScript)

Source: https://github.com/texasinstruments/c2000ware-core-sdk/blob/main/device_support/f28p55x/docs/html/search.html

This JavaScript snippet initializes global documentation options, including paths and version information. It then uses jQuery to enable the sticky navigation feature provided by the SphinxRtdTheme, ensuring the navigation bar remains visible during scrolling.

```JavaScript
var DOCUMENTATION_OPTIONS = { URL_ROOT:'./', VERSION:'v5.04.00.00', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', LINK_SUFFIX: '.html', HAS_SOURCE: false, SOURCELINK_SUFFIX: '.txt' };
jQuery(function () { SphinxRtdTheme.StickyNav.enable(); });
```

--------------------------------

### Getting eQEP Watchdog Timer Value - C

Source: https://github.com/texasinstruments/c2000ware-core-sdk/blob/main/device_support/f280015x/docs/html/modules/eqep.html

Retrieves the current value of the eQEP module's watchdog timer.

```C
uint16_t EQEP_getWatchdogTimerValue(uint32_t base)
```

--------------------------------

### Getting PPB Sample Delay Time Stamp (C/C++)

Source: https://github.com/texasinstruments/c2000ware-core-sdk/blob/main/device_support/f2837xs/docs/html/modules/adc.html

This function retrieves the sample delay time stamp from a specified Post-Processing Block (PPB). The returned value represents the number of system clock cycles elapsed between the SOC (Start of Conversion) being triggered and the actual start of the conversion.

```C
uint16_t ADC_getPPBDelayTimeStamp(uint32_t _base_, ADC_PPBNumber _ppbNumber_)
```

--------------------------------

### Initializing Documentation Options and Theme (JavaScript)

Source: https://github.com/texasinstruments/c2000ware-core-sdk/blob/main/device_support/f2838x/docs/html/modules/fsi.html

This snippet initializes global configuration options for a documentation site, including paths, version, and file suffixes. It also activates the sticky navigation feature provided by the Sphinx ReadTheDocs theme using jQuery, ensuring the navigation bar remains visible during scrolling.

```JavaScript
var DOCUMENTATION_OPTIONS = { URL_ROOT:'../', VERSION:'v5.04.00.00', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: false, SOURCELINK_SUFFIX: '.txt' }; jQuery(function () { SphinxRtdTheme.StickyNav.enable(); });
```

--------------------------------

### Initializing EtherCAT Sub-System Memory (C)

Source: https://github.com/texasinstruments/c2000ware-core-sdk/blob/main/device_support/f28p65x/docs/html/modules/escss.html

Initiates the memory initialization process for the EtherCAT Sub-System. Setting this function starts the initialization.

```C
void ESCSS_initMemory(uint32_t base)
```

--------------------------------

### Initializing Documentation Options and Sticky Navigation - JavaScript

Source: https://github.com/texasinstruments/c2000ware-core-sdk/blob/main/device_support/f2838x/docs/html/modules/gpio.html

This JavaScript code block initializes global documentation options for a Sphinx-generated site, including the root URL, version, and file suffixes. It also implements a sticky navigation bar feature, dynamically adjusting its top position based on scroll events to keep the navigation visible within the content area, and prevents default mousewheel scrolling behavior to implement custom scroll handling.

```JavaScript
var DOCUMENTATION_OPTIONS = { URL_ROOT:'../', VERSION:'v5.04.00.00', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: false, SOURCELINK_SUFFIX: '.txt' };
jQuery(function () { SphinxRtdTheme.StickyNav.enable(); });
var menuHeight = window.innerHeight;
var contentOffset = $(".wy-nav-content-wrap").offset();
var contentHeight = $(".wy-nav-content-wrap").height();
var contentBottom = contentOffset.top + contentHeight;
function setNavbarTop() {
  var scrollTop = $(window).scrollTop();
  var maxTop = scrollTop + menuHeight;
  // If past the header
  if (scrollTop > contentOffset.top && maxTop < contentBottom) {
    stickyTop = scrollTop - contentOffset.top;
  } else if (maxTop > contentBottom) {
    stickyTop = scrollTop - contentOffset.top - (maxTop - contentBottom);
  } else {
    stickyTop = 0;
  }
  $(".wy-nav-side").css("top", stickyTop);
}
$(document).ready(function() {
  setNavbarTop();
  $(window).scroll(function () {
    setNavbarTop();
  });
  $('body').on("mousewheel", function () {
    // Remove default behavior
    event.preventDefault();
    // Scroll without smoothing
    var wheelDelta = event.wheelDelta;
    var currentScrollPosition = window.pageYOffset;
    window.scrollTo(0, currentScrollPosition - wheelDelta);
  });
});
```

--------------------------------

### Initializing Documentation Options and Sticky Navigation (JavaScript)

Source: https://github.com/texasinstruments/c2000ware-core-sdk/blob/main/device_support/f28p65x/docs/html/modules/dma.html

This snippet initializes global configuration options for the documentation, such as root URL, version, and file suffixes. It then enables the sticky navigation feature provided by the Sphinx ReadTheDocs theme using jQuery, ensuring the navigation sidebar remains visible during scrolling.

```javascript
var DOCUMENTATION_OPTIONS = { URL_ROOT:'../', VERSION:'v5.02.00.00', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: false, SOURCELINK_SUFFIX: '.txt' };
jQuery(function () { SphinxRtdTheme.StickyNav.enable(); });
```

--------------------------------

### Starting HRCAP Calibration

Source: https://github.com/texasinstruments/c2000ware-core-sdk/blob/main/device_support/f28003x/docs/html/modules/hrcap.html

This function initiates the calibration process for the HRCAP module. It requires the base address of the HRCAP instance and does not return any value.

```C
void HRCAP_startCalibration(uint32_t _base_)
```

--------------------------------

### Initializing Documentation Options and Theme Navigation (JavaScript)

Source: https://github.com/texasinstruments/c2000ware-core-sdk/blob/main/device_support/f28003x/docs/html/modules/index.html

This snippet defines global configuration options for the documentation, such as URL roots and file suffixes. It also activates the sticky navigation feature provided by the SphinxRtdTheme, ensuring the sidebar remains visible as the user scrolls.

```JavaScript
var DOCUMENTATION_OPTIONS = { URL_ROOT:'../', VERSION:'v5.04.00.00', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: false, SOURCELINK_SUFFIX: '.txt' }; jQuery(function () { SphinxRtdTheme.StickyNav.enable(); });
```

--------------------------------

### Getting eQEP Watchdog Timer Value in C

Source: https://github.com/texasinstruments/c2000ware-core-sdk/blob/main/device_support/f28003x/docs/html/modules/eqep.html

This function retrieves the current value of the eQEP module's watchdog timer.

```C
uint16_t EQEP_getWatchdogTimerValue(uint32_t base)
```

--------------------------------

### Getting Ramp Generator Maximum Value - C/C++

Source: https://github.com/texasinstruments/c2000ware-core-sdk/blob/main/device_support/f28002x/docs/html/modules/cmpss.html

Retrieves the latched maximum reference value that is currently loaded into the ramp generator.

```C
uint16_t CMPSS_getMaxRampValue(uint32_t base)
```

--------------------------------

### Initializing Documentation Options and Sticky Navigation - JavaScript

Source: https://github.com/texasinstruments/c2000ware-core-sdk/blob/main/device_support/f2837xd/docs/html/modules/dac.html

This snippet initializes global documentation options for the Sphinx documentation theme and enables the sticky navigation feature using jQuery and SphinxRtdTheme. It sets paths, version, and file suffixes for the documentation.

```JavaScript
var DOCUMENTATION_OPTIONS = { URL_ROOT:'../', VERSION:'v5.04.00.00', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: false, SOURCELINK_SUFFIX: '.txt' };
jQuery(function () { SphinxRtdTheme.StickyNav.enable(); });
```

--------------------------------

### Initializing Sphinx Documentation Options and Sticky Navigation (JavaScript)

Source: https://github.com/texasinstruments/c2000ware-core-sdk/blob/main/device_support/f28003x/docs/html/modules/ecap.html

This snippet initializes global configuration options for a Sphinx-generated documentation site, including URL roots, version, and file suffixes. It also enables the sticky navigation feature provided by the SphinxRtdTheme once the DOM is ready, ensuring the navigation bar remains visible while scrolling.

```JavaScript
var DOCUMENTATION_OPTIONS = { URL_ROOT:'../', VERSION:'v5.04.00.00', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: false, SOURCELINK_SUFFIX: '.txt' };
jQuery(function () { SphinxRtdTheme.StickyNav.enable(); });
```

--------------------------------

### Getting Flash Deny Code Status in DCSM (C/C++)

Source: https://github.com/texasinstruments/c2000ware-core-sdk/blob/main/device_support/f28p65x/docs/html/modules/dcsm.html

Retrieves the status of the Deny Code register. The returned status can be used with provided defines.

```C/C++
uint16_t DCSM_getFlashDenyCodeStatus(void)
```

--------------------------------

### Initializing Documentation Page UI - JavaScript

Source: https://github.com/texasinstruments/c2000ware-core-sdk/blob/main/device_support/f2837xs/docs/html/modules/version.html

This JavaScript code initializes and manages the user interface elements of the documentation page, including enabling sticky navigation, adjusting the sidebar's top position based on scroll, and customizing mousewheel scroll behavior to prevent default smoothing.

```JavaScript
var DOCUMENTATION_OPTIONS = { URL_ROOT:'../', VERSION:'v5.04.00.00', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: false, SOURCELINK_SUFFIX: '.txt' };
jQuery(function () { SphinxRtdTheme.StickyNav.enable(); });
var menuHeight = window.innerHeight;
var contentOffset = $(".wy-nav-content-wrap").offset();
var contentHeight = $(".wy-nav-content-wrap").height();
var contentBottom = contentOffset.top + contentHeight;
function setNavbarTop() {
    var scrollTop = $(window).scrollTop();
    var maxTop = scrollTop + menuHeight;
    // If past the header
    if (scrollTop > contentOffset.top && maxTop < contentBottom) {
        stickyTop = scrollTop - contentOffset.top;
    } else if (maxTop > contentBottom) {
        stickyTop = scrollTop - contentOffset.top - (maxTop - contentBottom);
    } else {
        stickyTop = 0;
    }
    $(".wy-nav-side").css("top", stickyTop);
}
$(document).ready(function() {
    setNavbarTop();
    $(window).scroll(function () {
        setNavbarTop();
    });
    $('body').on("mousewheel", function () {
        // Remove default behavior
        event.preventDefault();
        // Scroll without smoothing
        var wheelDelta = event.wheelDelta;
        var currentScrollPosition = window.pageYOffset;
        window.scrollTo(0, currentScrollPosition - wheelDelta);
    });
});
```

--------------------------------

### Defining ESCSS_SOF_CAPTURE_TRIGGER in C/C++

Source: https://github.com/texasinstruments/c2000ware-core-sdk/blob/main/device_support/f2838x/docs/html_cm/modules/escss.html

Defines the `ESCSS_SOF_CAPTURE_TRIGGER` enumerator, which specifies the 'Start of Frame' as the capture trigger selection. This is a member of the `ESCSS_CaptureTrigger` enum.

```C++
ESCSS_SOF_CAPTURE_TRIGGER = 0U
```

--------------------------------

### Initializing Sphinx RTD Theme and Options (JavaScript)

Source: https://github.com/texasinstruments/c2000ware-core-sdk/blob/main/device_support/f2838x/docs/html_cm/modules/cputimer.html

This snippet defines global documentation configuration options and initializes the sticky navigation feature provided by the Sphinx Read the Docs theme. It ensures the navigation bar's core functionality is enabled upon page load.

```JavaScript
var DOCUMENTATION_OPTIONS = { URL_ROOT:'../', VERSION:'v5.04.00.00', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: false, SOURCELINK_SUFFIX: '.txt' };
jQuery(function () { SphinxRtdTheme.StickyNav.enable(); });
```

--------------------------------

### PMBus Command MFR_SETUP_ID Definition (C)

Source: https://github.com/texasinstruments/c2000ware-core-sdk/blob/main/device_support/f280015x/docs/html/modules/pmbus.html

Defines the PMBus command MFR_SETUP_ID with a hexadecimal value of 0xE7U, used for manufacturer-specific setup identification.

```C
PMBUS_CMD_MFR_SETUP_ID (0xE7U)
```

--------------------------------

### Getting Device Part ID in DCSM (C)

Source: https://github.com/texasinstruments/c2000ware-core-sdk/blob/main/device_support/f280015x/docs/html/modules/dcsm.html

Retrieves the device's PARTIDH value. This function returns the device PARTIDH value.

```C
uint32_t DCSM_getDevicePartID(void)
```