Go-HotSwap ™ User's Manual

Go-HotSwap ™ User's Manual

Version 10.2.1

Jungo Ltd.

Copyright © Jungo Ltd. 2001–2010 All Rights Reserved.

Information in this document is subject to change without notice. The software described in this document is furnished under a license agreement. The software may be used, copied or distributed only in accordance with that agreement. No part of this publication may be reproduced, stored in a retrieval system, or transmitted in any form or any means, electronically or mechanically, including photocopying and recording for any purpose without the written permission of Jungo Ltd.

Brand and product names mentioned in this document are trademarks of their respective owners and are used here only for identification purposes.

Table of Contents

1. General Overview

1.1. Introduction

1.2. Background

1.3. Feature List

1.3.1. Multi Operating System Support
1.3.2. Driver Architecture
1.3.3. Driver Development Tools
1.3.4. Cross Operating System Capability
1.3.5. Hardware Compatibility
1.3.6. Flexible Driver Models
1.3.7. Stability
1.3.8. Technical Support

1.4. Evaluate Go-HotSwap Before Purchasing

2. Architectural Overview

2.1. General

2.2. The Hot Swap Engine

2.2.1. Detecting Hot Swap Events

2.2.1.1. Polling the CompactPCI Bus
2.2.1.2. Monitoring the ENUM# signal

2.2.2. Allocating Required Resources (Enumeration)

2.2.2.1. I/O, Memory and Prefetchable Memory
2.2.2.2. Interrupts
2.2.2.3. Command Register

2.3. Kernel-Mode Messaging Mechanism

2.4. Driver Development Toolkit

2.5. Configuration Manager / hs_activate

2.6. Technical Overview Summary

3. Installation and Setup

3.1. Recommendations for Windows and Linux

3.2. System Requirements

3.2.1. Windows System Requirements
3.2.2. Linux System Requirements

3.3. Go-HotSwap Installation Instructions

3.3.1. Installation Instructions for Windows

3.3.2. Installation Instructions for Linux

3.3.2.1. Preparing the System for Installation
3.3.2.2. Installation
3.3.2.3. Restricting Hardware Access on Linux
3.3.2.4. The Installed Components

3.4. Checking Your Installation

3.4.1. On Windows
3.4.2. On Linux

3.5. Uninstalling Go-HotSwap

3.5.1. On Windows
3.5.2. On Linux

4. Using Go-HotSwap

4.1. Overview

4.2. What Does the Go-HotSwap Package Include?

4.2.1. Utilities
4.2.2. Samples

4.3. Using the API

4.3.1. Generate Driver's Hardware Access Code
4.3.2. Add Hot Swap Capabilities to the Driver

4.4. The Configuration Manager

4.4.1. Overview

4.4.2. Configuration Manager Database

4.4.2.1. Manual Registration Initiation
4.4.2.2. Automatic Registration Initiation

4.4.3. Configuring the Configuration Manager

4.4.4. Running a Batch File

4.4.5. Running an EXE File

4.4.6. Starting and Stopping Services

4.4.7. Using Legacy Drivers on Windows

A. Function Reference

A.1. Go-HotSwap

A.1.1. General
A.1.2. Calling Sequence
A.1.3. WD_WatchPciStart()
A.1.4. WD_WatchPciStop()

A.2. WinDriver Functions Used by Go-HotSwap

A.2.1. WD_Open()
A.2.2. WD_Version()
A.2.3. WD_Close()
A.2.4. PciEventCreate
A.2.5. PcmciaEventCreate
A.2.6. EventRegister
A.2.7. EventUnregister

A.3. WinDriver Status Codes

A.3.1. Introduction
A.3.2. Status Codes Returned by WinDriver

B. CompactPCI Hot Swap Overview

B.1. What is CompactPCI?

B.2. CompactPCI Features

B.3. Why CompactPCI?

B.4. Hot Swap

B.4.1. General

B.4.1.1. Enumeration and Dynamic Configuration
B.4.1.2. The Software Aspect

C. Purchasing Go-HotSwap

List of Figures

2.1. Go-HotSwap Architecture
2.2. Go-HotSwap Configuration
4.1. Notification Events
4.2. The Configuration Manager Database
4.3. New Device Inserted
4.4. Edit Device Configuration
4.5. Define Insertion Action
A.1. Go-HotSwap Calling Sequence
A.2. Low-Level Events Calling Sequence

© Jungo Ltd. 2001–2010


		Chapter 1. General Overview