Skip to content

Commit ea0de46

Browse files
Add documentation
1 parent 7fa7ee1 commit ea0de46

File tree

1 file changed

+50
-0
lines changed

1 file changed

+50
-0
lines changed

docs/powerpmac_simulator_setup.md

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
2+
# Running an EPICS IOC Against the Power PMAC Simulator
3+
4+
This guide explains how to run an EPICS IOC (Input/Output Controller) against the Power PMAC simulator. This is useful for development and testing of EPICS support without requiring physical hardware.
5+
6+
## Step 1: Launch the Power PMAC Simulator
7+
8+
1. Run the Power PMAC Simulator.
9+
2. Choose the desired CPU.
10+
3. Start the simulator and confirm it is running with the default IP address `172.20.0.200`.
11+
4. Ensure SSH access is enabled on the Windows workstation.
12+
13+
## Step 2: Forward the SSH Port
14+
15+
From your Linux development host, forward the simulator's SSH port using:
16+
17+
```bash
18+
ssh -L 2222:172.20.0.200:22 $USER@<windows-workstation-hostname-or-ip>
19+
```
20+
21+
Enter your password if requested.
22+
23+
## Step 3: Run the IOC
24+
25+
Configure the IOC to use the forwarded SSH port with the `pmacAsynSSHPort` class:
26+
27+
```tcl
28+
# st.cmd
29+
< envPaths
30+
cd ${TOP}
31+
32+
# Use SSH port forwarding to connect to simulator
33+
pmacAsynSSHPortConfigure("SIM_PMAC_PORT", "localhost", 2222, "root", "deltatau")
34+
35+
# Create the PMAC controller
36+
pmacCreateController("SIM_PMAC", "SIM_PMAC_PORT", 0, 0)
37+
```
38+
39+
Start the IOC:
40+
41+
```bash
42+
./bin/linux-x86_64/pmacSim st.cmd
43+
```
44+
45+
You should see output indicating a successful SSH connection to the simulator.
46+
47+
## Notes
48+
49+
- The simulator does not emulate all hardware features. Some commands may not behave identically to a real PMAC.
50+
- SSH port forwarding allows secure and flexible access to the simulator from remote development environments.

0 commit comments

Comments
 (0)