[uaccess] Formalise the uaccess API
[gpxe.git] / src / arch / i386 / firmware / pcbios / gateA20.c
1 #include <stdio.h>
2 #include <realmode.h>
3 #include <bios.h>
4 #include <gpxe/io.h>
5 #include <gpxe/timer.h>
6
7 #define K_RDWR          0x60            /* keyboard data & cmds (read/write) */
8 #define K_STATUS        0x64            /* keyboard status */
9 #define K_CMD           0x64            /* keybd ctlr command (write-only) */
10
11 #define K_OBUF_FUL      0x01            /* output buffer full */
12 #define K_IBUF_FUL      0x02            /* input buffer full */
13
14 #define KC_CMD_WIN      0xd0            /* read  output port */
15 #define KC_CMD_WOUT     0xd1            /* write output port */
16 #define KC_CMD_NULL     0xff            /* null command ("pulse nothing") */
17 #define KB_SET_A20      0xdf            /* enable A20,
18                                            enable output buffer full interrupt
19                                            enable data line
20                                            disable clock line */
21 #define KB_UNSET_A20    0xdd            /* enable A20,
22                                            enable output buffer full interrupt
23                                            enable data line
24                                            disable clock line */
25
26 #define SCP_A           0x92            /* System Control Port A */
27
28 enum { Disable_A20 = 0x2400, Enable_A20 = 0x2401, Query_A20_Status = 0x2402,
29         Query_A20_Support = 0x2403 };
30
31 enum a20_methods {
32         A20_UNKNOWN = 0,
33         A20_INT15,
34         A20_KBC,
35         A20_SCPA,
36 };
37
38 #define A20_MAX_RETRIES         32
39 #define A20_INT15_RETRIES       32
40 #define A20_KBC_RETRIES         (2^21)
41 #define A20_SCPA_RETRIES        (2^21)
42
43 /**
44  * Drain keyboard controller
45  */
46 static void empty_8042 ( void ) {
47         unsigned long time;
48
49         time = currticks() + TICKS_PER_SEC;     /* max wait of 1 second */
50         while ( ( inb ( K_CMD ) & ( K_IBUF_FUL | K_OBUF_FUL ) ) &&
51                 currticks() < time ) {
52                 iodelay();
53                 ( void ) inb_p ( K_RDWR );
54                 iodelay();
55         }
56 }
57
58 /**
59  * Fast test to see if gate A20 is already set
60  *
61  * @v retries           Number of times to retry before giving up
62  * @ret set             Gate A20 is set
63  */
64 static int gateA20_is_set ( int retries ) {
65         static uint32_t test_pattern = 0xdeadbeef;
66         physaddr_t test_pattern_phys = virt_to_phys ( &test_pattern );
67         physaddr_t verify_pattern_phys = ( test_pattern_phys ^ 0x100000 );
68         userptr_t verify_pattern_user = phys_to_user ( verify_pattern_phys );
69         uint32_t verify_pattern;
70
71         do {
72                 /* Check for difference */
73                 copy_from_user ( &verify_pattern, verify_pattern_user, 0,
74                                  sizeof ( verify_pattern ) );
75                 if ( verify_pattern != test_pattern )
76                         return 1;
77
78                 /* Avoid false negatives */
79                 test_pattern++;
80
81                 iodelay();
82
83                 /* Always retry at least once, to avoid false negatives */
84         } while ( retries-- >= 0 );
85
86         /* Pattern matched every time; gate A20 is not set */
87         return 0;
88 }
89
90 /*
91  * Gate A20 for high memory
92  *
93  * Note that this function gets called as part of the return path from
94  * librm's real_call, which is used to make the int15 call if librm is
95  * being used.  To avoid an infinite recursion, we make gateA20_set
96  * return immediately if it is already part of the call stack.
97  */
98 void gateA20_set ( void ) {
99         static char reentry_guard = 0;
100         static int a20_method = A20_UNKNOWN;
101         unsigned int discard_a;
102         unsigned int scp_a;
103         int retries = 0;
104
105         /* Avoid potential infinite recursion */
106         if ( reentry_guard )
107                 return;
108         reentry_guard = 1;
109
110         /* Fast check to see if gate A20 is already enabled */
111         if ( gateA20_is_set ( 0 ) )
112                 goto out;
113
114         for ( ; retries < A20_MAX_RETRIES ; retries++ ) {
115                 switch ( a20_method ) {
116                 case A20_UNKNOWN:
117                 case A20_INT15:
118                         /* Try INT 15 method */
119                         __asm__ __volatile__ ( REAL_CODE ( "int $0x15" )
120                                                : "=a" ( discard_a )
121                                                : "a" ( Enable_A20 ) );
122                         if ( gateA20_is_set ( A20_INT15_RETRIES ) ) {
123                                 DBG ( "Enabled gate A20 using BIOS\n" );
124                                 a20_method = A20_INT15;
125                                 goto out;
126                         }
127                         /* fall through */
128                 case A20_KBC:
129                         /* Try keyboard controller method */
130                         empty_8042();
131                         outb ( KC_CMD_WOUT, K_CMD );
132                         empty_8042();
133                         outb ( KB_SET_A20, K_RDWR );
134                         empty_8042();
135                         outb ( KC_CMD_NULL, K_CMD );
136                         empty_8042();
137                         if ( gateA20_is_set ( A20_KBC_RETRIES ) ) {
138                                 DBG ( "Enabled gate A20 using "
139                                       "keyboard controller\n" );
140                                 a20_method = A20_KBC;
141                                 goto out;
142                         }
143                         /* fall through */
144                 case A20_SCPA:
145                         /* Try "Fast gate A20" method */
146                         scp_a = inb ( SCP_A );
147                         scp_a &= ~0x01; /* Avoid triggering a reset */
148                         scp_a |= 0x02; /* Enable A20 */
149                         iodelay();
150                         outb ( scp_a, SCP_A );
151                         iodelay();
152                         if ( gateA20_is_set ( A20_SCPA_RETRIES ) ) {
153                                 DBG ( "Enabled gate A20 using "
154                                       "Fast Gate A20\n" );
155                                 a20_method = A20_SCPA;
156                                 goto out;
157                         }
158                 }
159         }
160
161         /* Better to die now than corrupt memory later */
162         printf ( "FATAL: Gate A20 stuck\n" );
163         while ( 1 ) {}
164
165  out:
166         if ( retries )
167                 DBG ( "%d attempts were required to enable A20\n",
168                       ( retries + 1 ) );
169         reentry_guard = 0;
170 }
171
172 void gateA20_unset ( void ) {
173         /* Not currently implemented */
174 }