Version History/Revision History
These are the main releases of Boulder Springs:
| Date | Revision | Description |
|---|---|---|
| 06 July 2018 | 0.6.0 | Internal release |
| 06 June 2018 | 0.5.0 | Initial release |
Intended Audience
This release is for internal Intel audiences.
Customer Support
For technical support, please contact your Intel representative.
Introduction
The Boulder Springs SDK makes it easy to take advantage of real-time hardware features on Intel platforms. These features enhance the handling of real-time workloads within a device. The SDK contains C language APIs, tools, and code samples. Benefits include:
- Increased determinism
- Reduced latencies for resource access (such as memory)
- Reduced jitter
This document provides system requirements, installation instructions, issues and limitations, and legal information.
To learn more about this product, see:
- Features listed in the Features in This Release section below.
- Reference documentation listed in the Related Documentation section below.
- Installation instructions in the Get Started Guide.
Features in This Release
New Features
tcc_audio_timestamps_sample
- Code sample that demonstrates how to use hardware-assisted time synchronization for cross-timestamping.
Detector Tool
- Added Cache Allocation Technology (CAT) visualizer output, which shows current cache allocation based on the resctrl filesystem (/sys/fs/resctrl).
- Added BIOS version check.
Changes to Existing Features
Measurement API
- Added utility API which converts CPU clocks to time units (nanoseconds or microseconds).
- Functions that output measurement results take an additional argument to select time units.
Hotspot Tool
- Added an option to choose time units for the histogram output.
Detector Tool
- Added -l argument, which lists details about "NOT RT READY" and "FAILED" checkers.
- Failing CPU model check will skip other checkers. Use -f argument to override.
Unsupported or Discontinued Features
None.
Fixed Issues
- If the tcc_cache_lock_create call fails (return code other than TCC_E_SUCCESS), the schemata for the default class of service (/sys/fs/resctrl/schemata) won't be restored to the previous state. You need to restore it manually by writing to the schemata file or rebooting the system.
Known Issues
- BIOS version APLIRVPA.X64.0205.B22.1801150308 contains an issue with fixing CPU frequency. The system will work on 800MHz instead of 1.6GHz. This affects all performance results.
Related Documentation
Online documentation:
The SDK also contains documentation in the following directories:
- API reference: /usr/share/boulder_springs/doc/api/index.html
- Sample sources: /usr/share/boulder_springs/samples
- Sample binaries: /usr/local/bin
Where to Find the Release
You can find the release on the Boulder Springs internal GitHub repo.
Release Content
The following table shows revision numbers of components of the Boulder Springs release.
| Subproject (component) | Location | Revision | Build date |
|---|---|---|---|
| Boulder Springs SDK installer | boulder_springs_install.sh | 0.6.0 | 06.07.2018 |
| Boulder Springs SDK | [installdir]/boulder_springs.tar.gz | 0.6.0 | 06.07.2018 |
| Linux kernel patches with pseudo-locking functionality | [installdir]/linux_rt_patches | 0.6.0 | 06.07.2018 |
| Yocto* recipes for building image with Boulder Springs | [installdir]/boulder_springs_deploy | 0.6.0 | 06.07.2018 |
Hardware and Software Compatibility
This release is compatible with Intel Atom® Processor E3900 Series (codename Apollo Lake-I):
- Leaf Hill customer reference board
- Juniper Hill customer reference board
To acquire these boards, contact your Intel representative.
For additional requirements, see the Get Started Guide.
BIOS/Firmware Version
This release supports BIOS version APLIRVPA.X64.0205.B22.1801150308.
Supported Operating Systems
This release supports Linux* operating systems.
Legal Information
INTEL CONFIDENTIAL
You may not use or facilitate the use of this document in connection with any infringement or other legal analysis concerning Intel products described herein. You agree to grant Intel a non-exclusive, royalty-free license to any patent claim thereafter drafted which includes subject matter disclosed herein.
No license (express or implied, by estoppel or otherwise) to any intellectual property rights is granted by this document.
All information provided here is subject to change without notice. Contact your Intel representative to obtain the latest Intel product specifications and roadmaps.
The products described may contain design defects or errors known as errata which may cause the product to deviate from published specifications. Current characterized errata are available on request.
Intel technologies' features and benefits depend on system configuration and may require enabled hardware, software or service activation. Performance varies depending on system configuration. No computer system can be absolutely secure. Learn more at the Boulder Springs main page.
Intel disclaims all express and implied warranties, including without limitation, the implied warranties of merchantability, fitness for a particular purpose, and non-infringement, as well as any warranty arising from course of performance, course of dealing, or usage in trade.
Intel, the Intel logo, and Intel Atom are trademarks of Intel Corporation in the U.S. and/or other countries.
*Other names and brands may be claimed as the property of others.
Copyright 2018 Intel Corporation.
This software and the related documents are Intel copyrighted materials, and your use of them is governed by the express license under which they were provided to you (License). Unless the License provides otherwise, you may not use, modify, copy, publish, distribute, disclose or transmit this software or the related documents without Intel's prior written permission.
This software and the related documents are provided as is, with no express or implied warranties, other than those that are expressly stated in the License.