SerDes Validation Framework

Getting Started

  • Installation
    • Quick Install
    • Requirements
    • Next Steps
  • Basic Usage
    • Quick Start
      • 1. Basic USB4 Validation
      • 2. Generate Reports
      • 3. REST API Usage (NEW in v1.4.1)
        • Starting the API Server
        • Using the API
        • CLI Client Usage
      • 3. Mock Mode for Development
    • Common Use Cases
      • Signal Analysis
      • Compliance Testing
      • Reporting and Visualization
    • Next Steps
  • Getting Started with SerDes Validation Framework
    • Overview
    • Installation
      • Prerequisites
      • Setup Steps
    • Basic Usage
      • Controller Setup
      • Instrument Connection
    • Mock Testing
      • Enabling Mock Mode
      • Basic Mock Example
      • Custom Mock Responses
    • Data Collection
      • Basic Measurement
      • Waveform Capture
    • Data Analysis
      • Basic Statistics
    • Complete Example
      • PAM4 Signal Analysis
    • Next Steps
    • Troubleshooting
      • Common Issues
      • Getting Help
    • See Also
  • Installation Guide
    • System Requirements
      • Operating Systems
      • Python Requirements
      • Hardware Requirements
        • Minimum Requirements
        • Recommended Requirements
        • Hardware Instruments (Optional)
    • Installation Methods
      • Method 1: PyPI Installation (Recommended)
        • Basic Installation
        • Installation with Optional Dependencies
        • Development Installation
      • Method 2: Conda Installation
      • Method 3: Source Installation
        • Clone and Install
        • Build from Source
    • Dependency Installation
      • Core Dependencies
      • Optional Dependencies
        • Visualization Support
        • Instrument Control Support
        • Documentation Support
    • Platform-Specific Instructions
      • Linux Installation
        • Ubuntu/Debian
        • CentOS/RHEL/Fedora
      • Windows Installation
        • Using pip (Recommended)
        • Using Anaconda
      • macOS Installation
        • Using pip
        • Using conda
    • Virtual Environment Setup
      • Using venv (Recommended)
      • Using conda
    • Configuration Setup
      • Initial Configuration
      • Environment Variables
    • Verification
      • Basic Verification
      • Comprehensive Test
      • Command Line Verification
    • Troubleshooting
      • Common Issues
        • Import Errors
        • Permission Issues (Linux/macOS)
        • Windows-Specific Issues
        • Dependency Conflicts
      • Getting Help
        • Check Installation Status
        • Debug Information
    • Next Steps
    • Support
    • Uninstallation
      • Remove Framework
      • Clean Conda Environment
  • Configuration Reference
    • Environment Variables
      • Core Configuration
        • SVF_MOCK_MODE
        • SVF_LOG_LEVEL
        • SVF_CONFIG_PATH
        • SVF_DATA_PATH
        • SVF_CACHE_PATH
      • USB4/Thunderbolt Configuration
        • SVF_USB4_DEFAULT_MODE
        • SVF_USB4_SSC_ENABLED
        • SVF_THUNDERBOLT_SECURITY_LEVEL
      • Instrument Configuration
        • SVF_INSTRUMENT_TIMEOUT
        • SVF_INSTRUMENT_RETRY_COUNT
        • SVF_SCOPE_ADDRESS
      • Reporting Configuration
        • SVF_REPORT_OUTPUT_DIR
        • SVF_REPORT_FORMAT
        • SVF_REPORT_INCLUDE_CHARTS
      • Performance Configuration
        • SVF_PARALLEL_PROCESSING
        • SVF_MAX_WORKERS
        • SVF_MEMORY_LIMIT
    • Configuration Files
      • Main Configuration File
      • Protocol-Specific Configuration
        • USB4 Configuration (~/.svf/usb4_config.yaml)
        • Thunderbolt Configuration (~/.svf/thunderbolt_config.yaml)
      • Instrument Configuration
        • Oscilloscope Configuration (~/.svf/instruments/scope_config.yaml)
    • Configuration Management
      • Loading Configuration
      • Runtime Configuration
      • Environment Override
    • Validation and Defaults
      • Configuration Validation
      • Default Values
    • Best Practices
      • Configuration Organization
      • Security Considerations
      • Performance Optimization
      • Development vs Production
    • Troubleshooting
      • Common Issues
        • Configuration Not Found
        • Invalid Configuration
        • Environment Variable Issues
      • Debug Configuration

USB4/Thunderbolt 4

  • USB4/Thunderbolt 4 Documentation
    • 🚀 Quick Start
    • 📋 Certification
    • 📚 Tutorials
    • 💻 Code Examples
    • 📖 User Guides
    • 📋 Reference
    • 🔧 Key Features
      • USB4 2.0 Support
      • Thunderbolt 4 Certification
      • Protocol Tunneling
      • Test Automation
    • 🎯 Common Use Cases
      • Device Manufacturers
      • Test Engineers
      • Certification Labs
      • Developers
    • 🚦 Getting Started Workflow
    • 📊 Framework Integration
    • 🆘 Support
    • 🔄 Recent Updates
  • USB4 Quick Start Guide
    • Prerequisites
    • Basic USB4 Validation
      • 1. Setting Up USB4 Validation
      • 2. Signal Analysis {#signal-analysis}
      • 3. Compliance Testing {#compliance-testing}
    • Thunderbolt 4 Certification
      • 1. Security Validation
      • 2. Daisy Chain Testing
    • USB4 Tunneling Validation
      • 1. PCIe Tunneling
      • 2. DisplayPort Tunneling
    • Mock Mode Testing
    • Generating Reports
      • 1. Compliance Report
      • 2. Certification Report
    • Visualization
      • 1. Eye Diagram Plotting
      • 2. Dual-Lane Analysis
    • Best Practices
      • 1. Test Configuration
      • 2. Error Handling
      • 3. Resource Management
    • Next Steps
    • Example Scripts
    • Support
  • USB4/Thunderbolt 4 API Reference
    • Signal Analysis {#signal-analysis}
      • Jitter Analysis {#jitter-analysis}
      • Lane Skew Analysis {#lane-skew-analysis}
    • Compliance Testing {#compliance-testing}
    • Performance Testing {#performance-testing}
    • Visualization {#visualization}
    • Core Classes
      • USB4Validator
        • Methods
      • USB4SignalAnalyzer
        • Methods
      • USB4ComplianceValidator
        • Methods
    • Thunderbolt 4 Classes
      • ThunderboltSecurityValidator
        • Methods
      • DaisyChainValidator
        • Methods
      • IntelCertificationSuite
        • Methods
    • Tunneling Classes
      • PCIeTunnelValidator
        • Methods
      • DisplayPortTunnelValidator
        • Methods
      • USB32TunnelValidator
    • Performance Classes
      • USB4PerformanceBenchmark
        • Methods
      • USB4StressTester
        • Methods
    • Data Classes
      • USB4SignalData
      • USB4ComplianceResult
      • USB4Limit
    • Constants and Enums
      • USB4SignalMode
      • USB4LinkState
      • USB4TunnelingMode
    • Specifications Classes
      • USB4Specs
      • ThunderboltSpecs
    • Usage Examples
      • Basic USB4 Validation
      • Thunderbolt 4 Certification
      • Mock Mode Testing
  • USB4/Thunderbolt 4 Certification
    • Certification Overview
      • USB4 Compliance
      • Thunderbolt 4 Certification
    • Certification Guides
      • Thunderbolt 4 Certification Guide
      • Intel Requirements
      • Test Procedures
    • Certification Workflow
    • Quick Links
    • Support
  • Thunderbolt 4 Certification Guide
    • Overview
    • Certification Requirements
      • Core Requirements
      • Technical Specifications
    • Setting Up Certification Testing
      • 1. Initialize Certification Suite
      • 2. Pre-Certification Checks
    • Core Certification Tests
      • 1. Signal Integrity Testing
      • 2. Security Validation
      • 3. Power Delivery Testing
      • 4. Daisy Chain Validation
      • 5. Display Support Testing
    • Performance Benchmarking
      • 1. Bandwidth Testing
      • 2. Latency Testing
      • 3. Thermal Testing
    • Certification Report Generation
      • 1. Compile Results
      • 2. Add All Test Results
      • 3. Generate Certification Report
    • Certification Checklist
      • Pre-Submission Checklist
      • Required Documentation
      • Submission Process
    • Troubleshooting Common Issues
      • Signal Integrity Failures
      • Security Test Failures
      • Power Delivery Issues
      • Performance Issues
    • Next Steps
    • Support Resources
  • Intel Thunderbolt 4 Certification Requirements
    • Overview
    • Core Requirements
      • 1. USB4 v2.0 Compliance
      • 2. Minimum Performance
      • 3. Power Delivery
      • 4. Security Features
      • 5. Display Support
      • 6. Daisy Chain Support
    • Technical Specifications
      • Signal Integrity Requirements
        • Eye Diagram Specifications
        • Jitter Specifications
        • Lane Skew Requirements
      • Power Delivery Specifications
        • Voltage Levels
        • Power Efficiency
      • Security Specifications
        • DMA Protection
        • Authentication
    • Test Requirements
      • Mandatory Tests
        • 1. Signal Integrity Tests
        • 2. Protocol Compliance Tests
        • 3. Security Tests
        • 4. Power Delivery Tests
        • 5. Interoperability Tests
      • Test Environment Requirements
        • Laboratory Conditions
        • Test Equipment
    • Documentation Requirements
      • Required Documents
        • 1. Technical Specification
        • 2. Test Reports
        • 3. Compliance Declaration
        • 4. User Documentation
    • Certification Process
      • 1. Pre-Certification
      • 2. Formal Testing
      • 3. Submission
      • 4. Review Process
      • 5. Certification
    • Compliance Checklist
      • Pre-Submission Checklist
      • Submission Package Checklist
    • Common Certification Issues
      • Signal Integrity Issues
      • Security Issues
      • Power Delivery Issues
      • Interoperability Issues
    • Support Resources
      • Intel Resources
      • Framework Resources
  • Basic USB4 Validation Examples
    • Simple Eye Diagram Analysis
      • Example 1: Basic Eye Diagram Measurement
      • Example 2: Dual-Lane Skew Analysis
    • Basic Compliance Testing
      • Example 3: Simple Compliance Check
      • Example 4: Custom Test Configuration
    • Mock Mode Examples
      • Example 5: Development with Mock Data
      • Example 6: CI/CD Testing
    • Basic Reporting
      • Example 7: Simple Report Generation
      • Example 8: JSON Report for API Integration
    • Basic Visualization
      • Example 9: Eye Diagram Plotting
      • Example 10: Dual-Lane Signal Plot
    • Error Handling Examples
      • Example 11: Robust Error Handling
    • Configuration Examples
      • Example 12: Environment Configuration
      • Example 13: Custom Test Limits
    • Integration Examples
      • Example 14: Simple Hardware Integration
    • Next Steps
    • Common Issues and Solutions
      • Issue 1: Import Errors
      • Issue 2: No Signal Data
  • USB4/Thunderbolt 4 Best Practices
    • Signal Generation Best Practices
      • 1. Signal Quality Optimization
        • Test Signal Generation
        • Signal Conditioning
      • 2. Measurement Setup
        • Oscilloscope Configuration
        • Probe Selection and Setup
    • Test Configuration Guidelines
      • 1. Environment Setup
        • Laboratory Conditions
        • Power Supply Configuration
      • 2. Test Sequencing
        • Optimal Test Order
        • Test Configuration Management
    • Performance Optimization
      • 1. Data Processing Optimization
        • Parallel Processing
        • Memory Management
        • Caching Strategy
      • 2. Test Execution Optimization
        • Smart Test Selection
        • Adaptive Test Parameters
    • Compliance Testing Strategies
      • 1. Systematic Approach
        • Test Coverage Matrix
        • Progressive Testing
      • 2. Failure Analysis
        • Automated Root Cause Analysis
        • Statistical Analysis
    • Documentation and Reporting
      • 1. Comprehensive Documentation
        • Test Documentation Standards
      • 2. Automated Reporting
        • Real-time Dashboards
    • Maintenance and Calibration
      • 1. Regular Calibration
        • Automated Calibration Procedures
      • 2. Preventive Maintenance
        • Equipment Health Monitoring
    • Summary

API Documentation

  • API Reference
    • Core APIs
      • Protocol Support
      • Analysis & Testing
      • Reporting & Visualization
      • Infrastructure
    • Quick Reference
      • Common Classes
        • USB4 Validation
        • Thunderbolt 4 Certification
        • Visualization
        • Reporting
        • Visualization
      • Common Enums and Constants
        • USB4 Signal Modes
        • Report Types
    • API Categories
      • 🔌 Protocol APIs
      • 📊 Analysis APIs
      • 🧪 Testing APIs
      • 📈 Reporting APIs
      • 🎨 Visualization APIs
      • 🔧 Infrastructure APIs
    • Usage Patterns
      • Basic Validation Workflow
      • Mock Mode Development
      • Custom Report Generation
    • Error Handling
      • Common Exceptions
      • Best Practices
    • Performance Considerations
      • Optimization Tips
      • Memory Management
    • Version Compatibility
      • API Stability
      • Deprecation Policy
    • Support and Resources
  • Reporting API Reference
    • Core Classes
      • USB4TestReporter
        • Constructor
        • Methods
    • Data Structures
      • TestSession
      • ReportTemplate
      • TrendDataPoint
      • RegressionAnalysis
    • Enumerations
      • ReportFormat
      • ReportType
    • Report Templates
      • Default Templates
        • Compliance HTML Template
        • Certification PDF Template
        • Trend Analysis Template
      • Custom Templates
    • Advanced Features
      • Trend Analysis {#trend-analysis}
      • Performance Regression Detection
      • Multi-Format Reports
    • Integration Examples
      • Automated Reporting in Test Sequences
      • CI/CD Integration
      • Performance Monitoring Dashboard
    • Best Practices
      • 1. Report Organization
      • 2. Template Customization
      • 3. Data Management
      • 4. Performance Monitoring
      • 5. Integration
    • Troubleshooting
      • Common Issues
      • Debug Mode
    • Next Steps
  • Instrument Control
    • Overview
    • Key Components
      • Controller Types
    • Basic Usage
      • Controller Initialization
      • Type-Safe Instrument Connection
      • Command Execution
      • Query Execution
    • Advanced Usage
      • Custom Response Types
      • Error Handling
    • Mock Configuration
      • Custom Mock Responses
      • Error Simulation
    • Best Practices
    • Examples
      • Basic Measurement
      • Automated Test Sequence
    • See Also
  • Mock Controller
    • Overview
    • Features
    • Installation
    • Environment Configuration
    • Basic Usage
    • Type Safety
    • Mock Response Configuration
      • Basic Responses
      • PAM4 Signal Generation
    • Error Simulation
    • Advanced Usage
      • Custom Error Handling
      • Response Validation
    • Best Practices
    • API Reference
      • Core Functions
        • get_instrument_controller()
        • get_instrument_mode()
      • MockInstrumentController Class
    • Testing
    • See Also
  • 224G Ethernet Protocol API
    • Overview
    • Type Safety
    • Equipment Setup
      • Scope Configuration
      • Mock Mode Configuration
    • Link Training
      • Training Configuration
      • Training Execution
    • Compliance Testing
      • Test Configuration
      • Running Tests
    • Mock Testing Example
    • Error Handling
    • See Also
  • PAM4 Signal Analysis API
    • Overview
    • Type Definitions
    • Data Classes
      • PAM4Levels
      • EVMResults
      • EyeResults
    • PAM4 Analyzer
      • Initialization
      • Signal Validation
      • Level Analysis
      • EVM Calculation
      • Eye Analysis
    • Error Handling
    • Usage Example
    • See Also
  • PCIe 6.0 API Reference
    • Overview
    • Core Modules
      • Constants and Specifications
        • SignalMode Enum
        • Specifications
      • Mode Switching
        • ModeSwitcher Class
      • Signal Analysis
        • Analysis Results
      • Link Training
        • Training Results
      • Equalization
        • Equalization Algorithms
      • Compliance Testing
        • Compliance Test Types
      • Test Sequences
        • Test Phases
      • Advanced Eye Diagram Analysis
        • Eye Analysis Features
    • Usage Examples
      • Basic PCIe Validation Workflow
      • Multi-Lane Analysis
    • Performance Characteristics
    • Error Handling
    • Thread Safety
    • See Also
  • USB4/Thunderbolt 4 API Reference
    • Core Classes
      • USB4Validator
        • Methods
      • USB4SignalAnalyzer
        • Methods
      • USB4LinkTraining
      • USB4PowerManager
    • Thunderbolt 4 Support
      • ThunderboltSecurityValidator
      • DaisyChainValidator
      • IntelCertificationSuite
    • Tunneling Validation
      • PCIeTunnelValidator
      • DisplayPortTunnelValidator
      • USB32TunnelValidator
    • Data Structures
      • USB4SignalData
      • USB4ComplianceResult
      • USB4SignalMode
      • USB4LinkState
      • USB4TunnelingMode
    • Configuration Classes
      • USB4Specs
      • USB4SignalSpecs
      • ThunderboltSpecs
    • Test Automation
      • USB4TestSequence
      • USB4PerformanceBenchmark
      • USB4StressTester
    • Instrument Integration
      • USB4ScopeController
      • USB4PatternGenerator
      • USB4PowerMeter
    • Mock Testing Support
    • Examples
      • Basic USB4 Validation
      • Thunderbolt 4 Certification
      • Multi-Protocol Tunneling
    • Best Practices
    • Troubleshooting
      • Common Issues
      • Debug Mode

Tutorials

  • Mock Testing Guide
    • Overview
    • Enabling Mock Mode
      • Environment Variable
      • Programmatic Control
      • Test Runner Integration
    • Mock Architecture
      • Realistic Data Generation
      • Complete API Coverage
      • Deterministic Results
    • Available Mock Classes
      • Core Analysis Mocks
        • DataAnalyzer Mock
        • SignalProcessor Mock
      • Protocol-Specific Mocks
        • USB4 Validation Mock
        • PCIe Analyzer Mock
        • Framework Integration Mock
    • Mock Data Generation
      • Signal Data Generation
      • Protocol-Specific Data
        • USB4 Test Data
        • PCIe Test Data
    • Writing Mock Tests
      • Basic Mock Test Structure
      • Advanced Mock Scenarios
        • Error Condition Testing
        • Performance Testing
        • Multi-Protocol Testing
    • Mock Configuration
      • Configurable Mock Behavior
      • Environment-Specific Configuration
    • CI/CD Integration
      • GitHub Actions Example
      • Jenkins Pipeline Example
    • Best Practices
      • 1. Realistic Mock Data
      • 2. Comprehensive Coverage
      • 3. Performance Considerations
      • 4. Maintainability
      • 5. Test Isolation
    • Debugging Mock Tests
      • Enable Debug Logging
      • Mock Inspection
      • Validation Against Real Hardware
    • Troubleshooting
      • Common Issues
      • Solutions
    • Next Steps
  • 224G Ethernet Validation Tutorial
    • Overview
    • Type-Safe Setup
      • Equipment Configuration
      • Data Validation
    • Link Training Validation
      • Training Configuration
      • Running Training
    • Compliance Testing
      • Test Configuration
      • Running Tests
    • Complete Example
      • Full Validation Sequence
    • Best Practices
      • 1. Type Validation
      • 2. Error Handling
      • 3. Results Validation
    • See Also
    • References
  • PAM4 Signal Analysis Tutorial
    • Overview
    • Basic Setup
      • Required Imports
      • Data Validation
    • Signal Generation
      • Test Signal Creation
    • Level Analysis
      • Basic Level Analysis
      • Level Quality Checks
    • EVM Analysis
      • EVM Calculation
      • EVM Quality Checks
    • Eye Analysis
      • Eye Measurements
      • Eye Quality Checks
    • Complete Example
      • Full Analysis Pipeline
    • Best Practices
      • 1. Array Validation
      • 2. Parameter Validation
      • 3. Result Validation
      • 4. Error Handling
    • Advanced Topics
      • Custom Analysis Pipeline
      • Signal Processing Utilities
      • Advanced Visualization
    • See Also
    • References
  • PCIe 6.0 Validation Tutorial
    • Overview
    • Prerequisites
    • Getting Started
      • 1. Basic Setup
      • 2. Signal Generation (for Testing)
    • Dual-Mode Operation
      • Mode Switching
      • Mode-Specific Analysis
    • Link Training
      • Basic Link Training
      • Advanced Training Configuration
    • Equalization
      • Adaptive Equalization
    • Compliance Testing
      • Basic Compliance Testing
      • Custom Compliance Limits
    • Multi-Lane Analysis
      • Multi-Lane Test Setup
    • Advanced Eye Diagram Analysis
      • Statistical Eye Analysis
    • Stress Testing
      • Environmental Stress Testing
    • Visualization
      • Signal Comparison Plot
      • Eye Diagram Visualization
    • Complete Validation Workflow
      • Automated PCIe 6.0 Validation
    • Best Practices
      • 1. Signal Quality Requirements
      • 2. Test Sequence Optimization
      • 3. Error Handling
    • Troubleshooting
      • Common Issues
      • Debug Tips
    • Conclusion
    • Next Steps

Examples

  • Mock Testing Examples
    • Overview
    • Basic Mock Mode Usage
      • Example 1: Enabling Mock Mode
      • Example 2: Basic Mock Validation
    • Mock Data Generation
      • Example 3: Custom Mock Signal Generation
      • Example 4: Mock Eye Diagram Data
    • Mock Testing Patterns
      • Example 5: Unit Testing with Mocks
      • Example 6: Integration Testing
    • CI/CD Integration Examples
      • Example 7: GitHub Actions Workflow
      • Example 8: CI/CD Test Script
    • Mock Performance Testing
      • Example 9: Performance Benchmarking with Mocks
      • Example 10: Memory Usage Testing
    • Advanced Mock Scenarios
      • Example 11: Custom Mock Behaviors
      • Example 12: Mock Data Persistence
  • Reporting Examples
    • Basic Reporting
      • Example 1: Simple Compliance Report
      • Example 2: Certification Report
    • Custom Report Templates
      • Example 3: Creating Custom Templates
      • Example 4: JSON Report Template
    • Advanced Reporting Features
      • Example 5: Trend Analysis Report
      • Example 6: Regression Testing Report
    • Multi-Format Reporting
      • Example 7: Generate Multiple Report Formats
      • Example 8: Automated Report Distribution
    • Interactive Reporting
      • Example 9: Web Dashboard Integration
    • Report Customization
      • Example 10: Dynamic Report Content
  • Data Analysis Examples
    • Overview
    • Example Files
      • Core Data Analysis Examples
      • Related Examples
    • Quick Start Examples
      • Basic Signal Analysis
      • Advanced Signal Generation
      • PAM4 Signal Analysis
      • Signal Quality Analysis
    • File Format Support
      • CSV File Analysis
      • NumPy Array Analysis
    • Advanced Analysis Examples
      • Frequency Domain Analysis
      • Statistical Analysis
    • Integration with PCIe Analysis
      • Combined PCIe and Data Analysis
    • Running the Examples
      • Command Line Usage
      • Script Parameters
      • Mock Mode Testing
    • Performance Optimization
      • Efficient Data Processing
    • Troubleshooting
      • Common Issues
      • Debug Mode
    • See Also
  • Mock Controller Examples
    • Basic Usage
      • Simple Mock Testing
      • Type-Safe Configuration
    • Advanced Examples
      • Custom Data Generation
      • Error Simulation
    • Complete Examples
      • Mock Oscilloscope
      • Mock Pattern Generator
      • Complete Test Setup
    • Best Practices
      • 1. Type Validation
      • 2. Error Handling
      • 3. Resource Cleanup
    • See Also
  • PCIe 6.0 Examples
    • Overview
    • Example Files
      • Core PCIe Example
      • Enhanced Examples with PCIe Integration
      • Production Scripts
    • Quick Start Examples
      • Basic PCIe Validation
      • Mode Switching Example
      • Link Training Example
      • Compliance Testing Example
      • Multi-Lane Analysis Example
    • Advanced Examples
      • Eye Diagram Analysis
      • Equalization Example
    • Running the Examples
      • Command Line Usage
      • Production Script Usage
      • Mock Mode Testing
    • Performance Examples
      • Benchmarking Code
      • Expected Performance
    • Integration Examples
      • CI/CD Integration
      • Docker Integration
      • Python Integration
    • Troubleshooting
      • Common Issues
      • Debug Mode
    • See Also
  • Testing Examples
    • Overview
    • Basic Unit Tests
      • Mock Controller Tests
      • Data Type Tests
    • Integration Tests
      • Mock Scope Tests
      • Signal Analysis Tests
    • Performance Tests
      • Mock Performance Testing
    • Error Handling Tests
      • Mock Error Tests
    • Running Tests
      • Test Execution
    • Best Practices
    • See Also

User Guides

  • Testing Guide
    • Test Infrastructure Overview
      • Test Categories
        • 1. Core Tests (91 tests) ✅
        • 2. Integration Tests (Partially Working)
        • 3. Performance Tests (Needs Work)
        • 4. Legacy Tests (Properly Isolated)
    • Test Execution Commands
      • Recommended Commands
      • Full Test Suite
    • Mock Testing Infrastructure
      • Automatic Mock Mode
      • Mock Implementation Features
        • Intelligent Protocol Detection
        • Realistic Signal Generation
        • Comprehensive Mock Classes
    • Test Configuration
      • pytest.ini Configuration
      • Test Markers
    • Writing Tests
      • Basic Test Structure
      • Multi-Protocol Integration Tests
      • Performance Testing
    • Error Handling and Testing
      • Conditional Import Testing
      • Error Condition Testing
    • CI/CD Integration
      • GitHub Actions Configuration
      • Test Reporting
    • Debugging Tests
      • Debug Logging
      • Test Isolation
      • Mock Inspection
    • Best Practices
      • 1. Test Organization
      • 2. Mock Implementation
      • 3. Error Handling
      • 4. Performance
      • 5. Maintainability
    • Troubleshooting
      • Common Issues
      • Solutions
    • Next Steps
  • Stress Testing Overview
    • 🔄 Loopback Stress Testing
      • Purpose
      • Key Features
      • Usage
      • When to Use
    • 🔧 USB4-Specific Stress Testing
      • Purpose
      • Key Features
      • Usage
      • When to Use
    • 📊 Comparison Matrix
    • 🎯 Choosing the Right Stress Testing
      • Use Loopback Stress Testing when:
      • Use USB4-Specific Stress Testing when:
    • 🔗 Integration Examples
      • Combined Testing Workflow
      • Framework Integration
    • 📚 Related Documentation
    • 🏗️ Architecture Notes
  • Jupyter Dashboard Guide
    • Overview
    • Quick Start
      • 1. Check Dependencies
      • 2. Create a Basic Dashboard
      • 3. Multi-Lane Analysis
    • Interactive Features (Jupyter Notebook)
      • 1. Real-time Controls
      • 2. Static Dashboard
    • Waveform Analysis
    • Configuration
    • Export Results
    • Protocol Support
      • USB4
      • PCIe
      • Ethernet
    • Integration with SVF
    • Examples
    • Jupyter Notebook
    • Dependencies
    • Troubleshooting
      • Common Issues
      • Performance Tips
    • API Reference
  • CI/CD Integration Guide
    • Overview
    • Quick Start
      • GitHub Actions (Recommended)
      • Jenkins Pipeline
    • Platform-Specific Configurations
      • GitLab CI
      • Azure DevOps
    • Advanced CI/CD Features
      • Performance Regression Detection
      • Multi-Platform Testing
      • Docker Integration
    • Quality Gates
      • Pre-commit Hooks
      • Branch Protection Rules
    • Monitoring and Alerting
      • Test Result Monitoring
    • Best Practices
      • 1. Test Organization
      • 2. Performance Optimization
      • 3. Reliability
      • 4. Security
      • 5. Monitoring
    • Troubleshooting
      • Common CI/CD Issues
      • Debug CI/CD Issues
    • Next Steps
  • Troubleshooting Guide
    • Overview
    • Diagnostic Tools
      • System Check
      • Hardware Diagnostics
      • Mock Testing Diagnostics
    • Common Issues
      • Hardware Problems
      • Mock Testing Problems
      • Data Analysis Issues
    • Solution Steps
      • Hardware Solutions
      • Mock Testing Solutions
      • Type Validation Solutions
    • See Also
  • Instrument Setup Guide
    • Overview
    • Hardware Requirements
      • Minimum Requirements
      • Recommended Equipment
    • Physical Setup
      • GPIB Configuration
      • Signal Connections
    • Mock Setup
      • Environment Configuration
      • Mock Instrument Creation
    • Validation
      • Hardware Validation
      • Mock Validation
    • Common Issues
      • Hardware Issues
      • Mock Issues
    • See Also
  • Environment Configuration Guide
    • Overview
    • Core Environment Variables
      • Mock Mode Control
      • Script Usage
    • Test Configuration
      • Debug Level
      • Python Usage
    • Performance Configuration
      • Memory Settings
      • Implementation
    • Hardware Configuration
      • GPIB Settings
      • Validation
    • Complete Example
      • Environment Setup
      • Python Implementation
    • Best Practices
    • See Also

Reference

  • Configuration Reference
    • Environment Variables
      • Core Configuration
        • SVF_MOCK_MODE
        • SVF_LOG_LEVEL
        • SVF_CONFIG_PATH
        • SVF_DATA_PATH
        • SVF_CACHE_PATH
      • USB4/Thunderbolt Configuration
        • SVF_USB4_DEFAULT_MODE
        • SVF_USB4_SSC_ENABLED
        • SVF_THUNDERBOLT_SECURITY_LEVEL
      • Instrument Configuration
        • SVF_INSTRUMENT_TIMEOUT
        • SVF_INSTRUMENT_RETRY_COUNT
        • SVF_SCOPE_ADDRESS
      • Reporting Configuration
        • SVF_REPORT_OUTPUT_DIR
        • SVF_REPORT_FORMAT
        • SVF_REPORT_INCLUDE_CHARTS
      • Performance Configuration
        • SVF_PARALLEL_PROCESSING
        • SVF_MAX_WORKERS
        • SVF_MEMORY_LIMIT
    • Configuration Files
      • Main Configuration File
      • Protocol-Specific Configuration
        • USB4 Configuration (~/.svf/usb4_config.yaml)
        • Thunderbolt Configuration (~/.svf/thunderbolt_config.yaml)
      • Instrument Configuration
        • Oscilloscope Configuration (~/.svf/instruments/scope_config.yaml)
    • Configuration Management
      • Loading Configuration
      • Runtime Configuration
      • Environment Override
    • Validation and Defaults
      • Configuration Validation
      • Default Values
    • Best Practices
      • Configuration Organization
      • Security Considerations
      • Performance Optimization
      • Development vs Production
    • Troubleshooting
      • Common Issues
        • Configuration Not Found
        • Invalid Configuration
        • Environment Variable Issues
      • Debug Configuration
  • Table of Contents
    • Getting Started
    • USB4/Thunderbolt 4 Documentation
    • Tutorials
    • User Guides
    • API Documentation
    • Examples
    • Reference
    • Development
    • Support

Project Info

  • Contributing to SerDes Validation Framework
    • How to Contribute
    • Code of Conduct
    • Reporting Issues
    • Coding Standards
  • Documentation v1.4.1
    • Building the Documentation
    • Directory Structure
    • 🆕 New Documentation in v1.4.1
      • REST API Documentation
      • Jupyter Dashboard Documentation
      • Stress Testing Documentation
    • Documentation Standards
    • Adding New Documentation
SerDes Validation Framework
  • Table of Contents
  • View page source

Table of Contents

Getting Started

  • Installation Guide

  • Quick Start Tutorial

  • USB4 Quick Start

  • Basic Usage

USB4/Thunderbolt 4 Documentation

  • USB4 Documentation Hub

  • USB4 Quick Start

  • USB4 API Reference

  • Thunderbolt 4 Certification

  • Intel Requirements

  • USB4 Examples

  • USB4 Best Practices

Tutorials

  • Getting Started

  • Mock Testing

  • 224G Validation

  • PAM4 Analysis

User Guides

  • Installation

  • Testing Strategies

  • CI/CD Integration

  • Troubleshooting

  • Environment Configuration

  • Instrument Setup

API Documentation

  • API Overview

  • USB4/Thunderbolt 4

  • Reporting System

  • Visualization

  • Instrument Control

  • Mock Controller

  • 224G Ethernet

  • PAM4 Analysis

Examples

  • USB4 Examples

  • Mock Testing Examples

  • Reporting Examples

Reference

  • Configuration Reference

  • Command Line Interface

  • Error Codes

  • Glossary

Development

  • Contributing Guide

  • Development Setup

  • Testing Guide

  • Release Process

Support

  • FAQ

  • Known Issues

  • Community

  • Professional Support

Previous Next

© Copyright 2025, SerDes Validation Framework Contributors.

Built with Sphinx using a theme provided by Read the Docs.