Project

General

Profile

Statistics
| Revision:

root / proj / libs / uart / src / uart.c @ 345

History | View | Annotate | Download (15.7 KB)

1 235 up20180642
#include <lcom/lcf.h>
2
3
#include "uart.h"
4
5 275 up20180642
#include "queue.h"
6 235 up20180642
#include "errors.h"
7
8 249 up20180642
#define UART_BITRATE                            115200
9
#define UART_WAIT                               20 //microseconds
10 241 up20180642
11 249 up20180642
#define UART_RBR                                0
12
#define UART_THR                                0
13
#define UART_IER                                1
14
#define UART_IIR                                2
15
#define UART_FCR                                2
16
#define UART_LCR                                3
17
#define UART_MCR                                4
18
#define UART_LSR                                5
19
#define UART_MSR                                6
20
#define UART_SR                                 7
21 241 up20180642
22 249 up20180642
#define UART_DLL                                0
23
#define UART_DLM                                1
24 241 up20180642
25 249 up20180642
/// LCR
26 277 up20180642
#define UART_BITS_PER_CHAR_POS                  0
27 249 up20180642
#define UART_STOP_BITS_POS                      2
28
#define UART_PARITY_POS                         3
29
#define UART_BREAK_CONTROL_POS                  6
30
#define UART_DLAB_POS                           7
31 241 up20180642
32 249 up20180642
#define UART_BITS_PER_CHAR                      (BIT(0) | BIT(1))
33
#define UART_STOP_BITS                          (BIT(2))
34
#define UART_PARITY                             (BIT(3) | BIT(4) | BIT(5))
35
#define UART_BREAK_CONTROL                      (BIT(6))
36
#define UART_DLAB                               (BIT(7))
37 241 up20180642
38 249 up20180642
#define UART_GET_BITS_PER_CHAR(n)               (((n)&UART_BITS_PER_CHAR) + 5)
39
#define UART_GET_STOP_BITS(n)                   (((n)&UART_STOP_BITS)? 2 : 1)
40
#define UART_GET_PARITY(n)                      (((n)&UART_PARITY       )>>UART_PARITY_POS       )
41
#define UART_GET_BREAK_CONTROL(n)               (((n)&UART_BREAK_CONTROL)>>UART_BREAK_CONTROL_POS)
42
#define UART_GET_DLAB(n)                        (((n)&UART_DLAB         )>>UART_DLAB_POS         )
43
#define UART_GET_DIV_LATCH(m,l)                 ((m)<<8 | (l))
44
#define UART_GET_DLL(n)                         ((n)&0xFF)
45
#define UART_GET_DLM(n)                         (((n)>>8)&0xFF)
46 242 up20180642
47 249 up20180642
/// IER
48 252 up20180642
#define UART_INT_EN_RX_POS                      0
49
#define UART_INT_EN_TX_POS                      1
50 249 up20180642
#define UART_INT_EN_RECEIVER_LINE_STAT_POS      2
51
#define UART_INT_EN_MODEM_STAT_POS              3
52 242 up20180642
53 252 up20180642
#define UART_INT_EN_RX                          (BIT(0))
54
#define UART_INT_EN_TX                          (BIT(1))
55 249 up20180642
#define UART_INT_EN_RECEIVER_LINE_STAT          (BIT(2))
56
#define UART_INT_EN_MODEM_STAT                  (BIT(3))
57 242 up20180642
58 252 up20180642
#define UART_GET_INT_EN_RX(n)                   (((n)&UART_INT_EN_RX                )>>UART_INT_EN_RX_POS                )
59
#define UART_GET_INT_EN_TX(n)                   (((n)&UART_INT_EN_TX                )>>UART_INT_EN_TX_POS                )
60
#define UART_GET_INT_EN_RECEIVER_LINE_STAT(n)   (((n)&UART_INT_EN_RECEIVER_LINE_STAT)>>UART_INT_EN_RECEIVER_LINE_STAT_POS)
61
#define UART_GET_INT_EN_MODEM_STAT(n)           (((n)&UART_INT_EN_MODEM_STAT        )>>UART_INT_EN_MODEM_STAT_POS        )
62 249 up20180642
63
/// LSR
64
#define UART_RECEIVER_READY_POS                 0
65 261 up20180642
#define UART_OVERRUN_ERROR_POS                  1
66
#define UART_PARITY_ERROR_POS                   2
67
#define UART_FRAMING_ERROR_POS                  3
68 249 up20180642
#define UART_TRANSMITTER_EMPTY_POS              5
69
70
#define UART_RECEIVER_READY                     (BIT(0))
71 261 up20180642
#define UART_OVERRUN_ERROR                      (BIT(1))
72
#define UART_PARITY_ERROR                       (BIT(2))
73
#define UART_FRAMING_ERROR                      (BIT(3))
74 249 up20180642
#define UART_TRANSMITTER_EMPTY                  (BIT(5))
75
76
#define UART_GET_RECEIVER_READY(n)              (((n)&UART_RECEIVER_READY           )>>UART_RECEIVER_READY_POS           )
77 261 up20180642
#define UART_GET_OVERRUN_ERROR                  (((n)&UART_OVERRUN_ERROR            )>>UART_OVERRUN_ERROR_POS            )
78
#define UART_GET_PARITY_ERROR                   (((n)&UART_PARITY_ERROR             )>>UART_PARITY_ERROR_POS             )
79
#define UART_GET_FRAMING_ERROR                  (((n)&UART_FRAMING_ERROR            )>>UART_FRAMING_ERROR_POS            )
80 249 up20180642
#define UART_GET_TRANSMITTER_EMPTY(n)           (((n)&UART_TRANSMITTER_EMPTY        )>>UART_TRANSMITTER_EMPTY_POS        )
81
82 275 up20180642
/// IIR
83 277 up20180642
#define UART_INT_PEND_POS                       1
84
85
#define UART_INT_PEND                           (BIT(3)|BIT(2)|BIT(1))
86
87 275 up20180642
#define UART_GET_IF_INT_PEND(n)                 (!((n)&1))
88 277 up20180642
typedef enum {
89
    uart_int_receiver_line_stat = (         BIT(1) | BIT(0)),
90
    uart_int_rx                 = (         BIT(1)         ),
91
    uart_int_char_timeout_fifo  = (BIT(2) | BIT(1)         ),
92
    uart_int_tx                 = (                  BIT(0)),
93
    uart_int_modem_stat         = (0)
94
} uart_int_code;
95
#define UART_GET_INT_PEND(n)                    ((uart_int_code)(((n)&UART_INT_PEND)>>UART_INT_PEND_POS))
96 275 up20180642
97 263 up20180642
int (subscribe_uart_interrupt)(uint8_t interrupt_bit, int *interrupt_id) {
98
    if (interrupt_id == NULL) return 1;
99
    *interrupt_id = interrupt_bit;
100
    return (sys_irqsetpolicy(COM1_IRQ, IRQ_REENABLE | IRQ_EXCLUSIVE, interrupt_id));
101
}
102
103 252 up20180642
static void uart_parse_config(uart_config *config){
104
    /// LCR
105
    config->bits_per_char          = UART_GET_BITS_PER_CHAR     (config->lcr);
106
    config->stop_bits              = UART_GET_STOP_BITS         (config->lcr);
107
    config->parity                 = UART_GET_PARITY            (config->lcr); if((config->parity & BIT(0)) == 0) config->parity = uart_parity_none;
108
    config->break_control          = UART_GET_BREAK_CONTROL     (config->lcr);
109
    config->dlab                   = UART_GET_DLAB              (config->lcr);
110
    /// IER
111
    config->received_data_int      = UART_GET_INT_EN_RX                (config->ier);
112
    config->transmitter_empty_int  = UART_GET_INT_EN_TX                (config->ier);
113
    config->receiver_line_stat_int = UART_GET_INT_EN_RECEIVER_LINE_STAT(config->ier);
114
    config->modem_stat_int         = UART_GET_INT_EN_MODEM_STAT        (config->ier);
115
    /// DIV LATCH
116 324 up20180642
    config->divisor_latch          = (uint16_t)UART_GET_DIV_LATCH(config->dlm, config->dll);
117 252 up20180642
}
118
119
static int uart_get_lcr(int base_addr, uint8_t *p){
120
    return util_sys_inb(base_addr+UART_LCR, p);
121
}
122
static int uart_set_lcr(int base_addr, uint8_t config){
123
    if(sys_outb(base_addr+UART_LCR, config)) return WRITE_ERROR;
124
    return SUCCESS;
125
}
126
static int uart_get_lsr(int base_addr, uint8_t *p){
127
    return util_sys_inb(base_addr+UART_LSR, p);
128
}
129 275 up20180642
static int uart_get_iir(int base_addr, uint8_t *p){
130
    return util_sys_inb(base_addr+UART_IIR, p);
131
}
132 252 up20180642
133
static int uart_enable_divisor_latch(int base_addr){
134
    int ret = SUCCESS;
135
    uint8_t conf; if((ret = uart_get_lcr(base_addr, &conf))) return ret;
136
    return uart_set_lcr(base_addr, conf | UART_DLAB);
137
}
138
static int uart_disable_divisor_latch(int base_addr){
139
    int ret = SUCCESS;
140
    uint8_t conf; if((ret = uart_get_lcr(base_addr, &conf))) return ret;
141
    return uart_set_lcr(base_addr, conf & (~UART_DLAB));
142
}
143
144
static int uart_get_ier(int base_addr, uint8_t *p){
145
    int ret;
146
    if((ret = uart_disable_divisor_latch(base_addr))) return ret;
147
    return util_sys_inb(base_addr+UART_IER, p);
148
}
149
static int uart_set_ier(int base_addr, uint8_t n){
150
    int ret;
151
    if((ret = uart_disable_divisor_latch(base_addr))) return ret;
152
    if(sys_outb(base_addr+UART_IER, n)) return WRITE_ERROR;
153
    return SUCCESS;
154
}
155
156 235 up20180642
int uart_get_config(int base_addr, uart_config *config){
157
    int ret = SUCCESS;
158
159
    config->base_addr = base_addr;
160
161 252 up20180642
    if((ret = uart_get_lcr(base_addr, &config->lcr))) return ret;
162 235 up20180642
163 252 up20180642
    if((ret = uart_get_ier(base_addr, &config->ier))) return ret;
164 242 up20180642
165
    if((ret = uart_enable_divisor_latch (base_addr))) return ret;
166 235 up20180642
    if((ret = util_sys_inb(base_addr+UART_DLL, &config->dll   ))) return ret;
167
    if((ret = util_sys_inb(base_addr+UART_DLM, &config->dlm   ))) return ret;
168 242 up20180642
    if((ret = uart_disable_divisor_latch(base_addr))) return ret;
169 235 up20180642
170
    uart_parse_config(config);
171
    return ret;
172
}
173
void uart_print_config(uart_config config){
174 249 up20180642
175
    printf("%s configuration:\n", (config.base_addr == COM1_ADDR ? "COM1" : "COM2"));
176
    printf("\tLCR = 0x%X: %d bits per char\t %d stop bits\t", config.lcr, config.bits_per_char, config.stop_bits);
177
    if((config.parity&BIT(0)) == 0) printf("NO parity\n");
178 235 up20180642
    else switch(config.parity){
179 324 up20180642
        case uart_parity_none: printf("NO parity\n"      ); break;
180 249 up20180642
        case uart_parity_odd : printf("ODD parity\n"     ); break;
181
        case uart_parity_even: printf("EVEN parity\n"    ); break;
182 235 up20180642
        case uart_parity_par1: printf("parity bit is 1\n"); break;
183
        case uart_parity_par0: printf("parity bit is 0\n"); break;
184 324 up20180642
        //default              : printf("invalid\n"        ); break;
185 235 up20180642
    }
186 249 up20180642
    printf("\tDLM = 0x%02X DLL=0x%02X: bitrate = %d bps\n", config.dlm, config.dll, UART_BITRATE/config.divisor_latch);
187
    printf("\tIER = 0x%02X: Rx interrupts: %s\tTx interrupts: %s\n", config.ier,
188
        (config.received_data_int     ? "ENABLED":"DISABLED"),
189
        (config.transmitter_empty_int ? "ENABLED":"DISABLED"));
190 235 up20180642
}
191
192
int uart_set_bits_per_character(int base_addr, uint8_t bits_per_char){
193
    if(bits_per_char < 5 || bits_per_char > 8) return INVALID_ARG;
194
    int ret = SUCCESS;
195
    bits_per_char = (bits_per_char-5)&0x3;
196 252 up20180642
    uint8_t conf; if((ret = uart_get_lcr(base_addr, &conf))) return ret;
197 235 up20180642
    conf = (conf & (~UART_BITS_PER_CHAR)) | bits_per_char;
198 252 up20180642
    return uart_set_lcr(base_addr, conf);
199 235 up20180642
}
200
int uart_set_stop_bits(int base_addr, uint8_t stop){
201
    if(stop != 1 && stop != 2) return INVALID_ARG;
202
    int ret = SUCCESS;
203
    stop -= 1;
204 324 up20180642
    stop = (uint8_t)((stop&1)<<2);
205 252 up20180642
    uint8_t conf; if((ret = uart_get_lcr(base_addr, &conf))) return ret;
206 235 up20180642
    conf = (conf & (~UART_STOP_BITS)) | stop;
207 252 up20180642
    return uart_set_lcr(base_addr, conf);
208 235 up20180642
}
209
int uart_set_parity(int base_addr, uart_parity par){
210
    int ret = SUCCESS;
211 324 up20180642
    uint8_t parity = (uint8_t)(par << 3);
212 252 up20180642
    uint8_t conf; if((ret = uart_get_lcr(base_addr, &conf))) return ret;
213 235 up20180642
    conf = (conf & (~UART_PARITY)) | parity;
214 252 up20180642
    return uart_set_lcr(base_addr, conf);
215 235 up20180642
}
216 328 up20180642
int uart_set_bit_rate(int base_addr, uint32_t bit_rate){
217 235 up20180642
    int ret = SUCCESS;
218 324 up20180642
    uint16_t latch = (uint16_t)(UART_BITRATE/bit_rate);
219 241 up20180642
    uint8_t dll = UART_GET_DLL(latch);
220
    uint8_t dlm = UART_GET_DLM(latch);
221 235 up20180642
    if((ret = uart_enable_divisor_latch(base_addr))) return ret;
222
    if(sys_outb(base_addr+UART_DLL, dll)) return WRITE_ERROR;
223
    if(sys_outb(base_addr+UART_DLM, dlm)) return WRITE_ERROR;
224 249 up20180642
    if((ret = uart_disable_divisor_latch(base_addr))) return ret;
225 235 up20180642
    return SUCCESS;
226
}
227 249 up20180642
228 252 up20180642
static int uart_get_char(int base_addr, uint8_t *p){
229 249 up20180642
    int ret;
230
    if((ret = uart_disable_divisor_latch(base_addr))) return ret;
231
    return util_sys_inb(base_addr+UART_RBR, p);
232
}
233 252 up20180642
static int uart_send_char(int base_addr, uint8_t c){
234 249 up20180642
    int ret;
235
    if((ret = uart_disable_divisor_latch(base_addr))) return ret;
236 252 up20180642
    if(sys_outb(base_addr+UART_THR, c)) return WRITE_ERROR;
237 249 up20180642
    return SUCCESS;
238
}
239 252 up20180642
static int uart_receiver_ready(int base_addr){
240 249 up20180642
    uint8_t lsr;
241
    if(uart_get_lsr(base_addr, &lsr)) return false;
242
    return UART_GET_RECEIVER_READY(lsr);
243
}
244 252 up20180642
static int uart_transmitter_empty(int base_addr){
245 249 up20180642
    uint8_t lsr;
246
    if(uart_get_lsr(base_addr, &lsr)) return false;
247
    return UART_GET_TRANSMITTER_EMPTY(lsr);
248
}
249 252 up20180642
250
int uart_enable_int_rx(int base_addr){
251
    int ret;
252
    uint8_t ier;
253
    if((ret = uart_get_ier(base_addr, &ier))) return ret;
254
    ier |= UART_INT_EN_RX;
255
    return uart_set_ier(base_addr, ier);
256
}
257
int uart_disable_int_rx(int base_addr){
258
    int ret;
259
    uint8_t ier;
260
    if((ret = uart_get_ier(base_addr, &ier))) return ret;
261
    ier &= ~UART_INT_EN_RX;
262
    return uart_set_ier(base_addr, ier);
263
}
264
int uart_enable_int_tx(int base_addr){
265
    int ret;
266
    uint8_t ier;
267
    if((ret = uart_get_ier(base_addr, &ier))) return ret;
268
    ier |= UART_INT_EN_TX;
269
    return uart_set_ier(base_addr, ier);
270
}
271
int uart_disable_int_tx(int base_addr){
272
    int ret;
273
    uint8_t ier;
274
    if((ret = uart_get_ier(base_addr, &ier))) return ret;
275
    ier &= ~UART_INT_EN_TX;
276
    return uart_set_ier(base_addr, ier);
277
}
278
279 283 up20180642
/// NCTP
280 261 up20180642
281 344 up20180642
//#define NCTP_START      0x80
282
//#define NCTP_END        0xFF
283 261 up20180642
#define NCTP_OK         0xFF
284
#define NCTP_NOK        0x00
285
286 324 up20180642
static queue_t *out = NULL;
287
static queue_t *in  = NULL;
288
static void (*process)(const uint8_t*, const size_t) = NULL;
289 261 up20180642
290 298 up20180642
int nctp_init(void){
291 275 up20180642
    out = queue_ctor(); if(out == NULL) return NULL_PTR;
292
    in  = queue_ctor(); if(in  == NULL) return NULL_PTR;
293 297 up20180642
    return SUCCESS;
294
}
295 298 up20180642
int nctp_dump(void){
296
    int ret;
297
    if((ret = nctp_free())) return ret;
298
    return nctp_init();
299
}
300 297 up20180642
int nctp_set_processor(void (*proc_func)(const uint8_t*, const size_t)){
301 287 up20180642
    process = proc_func;
302 275 up20180642
    return SUCCESS;
303 261 up20180642
}
304 275 up20180642
int nctp_free(void){
305
    while(!queue_empty(out)){
306
        free(queue_top(out));
307
        queue_pop(out);
308 261 up20180642
    }
309 275 up20180642
    while(!queue_empty(in)){
310
        free(queue_top(in));
311
        queue_pop(in);
312 261 up20180642
    }
313 275 up20180642
    return SUCCESS;
314 261 up20180642
}
315
316 325 up20180642
int nctp_send(size_t num, const uint8_t *const *ptr, const size_t *const sz){
317 261 up20180642
    int ret;
318 344 up20180642
    uint16_t sz_total = 0;{
319
        for(size_t i = 0; i < num; ++i)
320
            sz_total += sz[i];
321
    }
322 275 up20180642
    uint8_t *tmp;
323 344 up20180642
    tmp = malloc(sizeof(uint8_t)); *tmp = *((uint8_t*)(&sz_total)+0); queue_push(out, tmp);
324
    tmp = malloc(sizeof(uint8_t)); *tmp = *((uint8_t*)(&sz_total)+1); queue_push(out, tmp);
325 261 up20180642
    for(size_t i = 0; i < num; ++i){
326 325 up20180642
        const uint8_t *p = ptr[i]; const size_t s = sz[i];
327 275 up20180642
        for(size_t j = 0; j < s; ++j, ++p){
328
            tmp = malloc(sizeof(uint8_t)); *tmp = *p; queue_push(out, tmp);
329
        }
330 261 up20180642
    }
331 344 up20180642
332 275 up20180642
    if(uart_transmitter_empty(COM1_ADDR)){
333
        if((ret = uart_send_char(COM1_ADDR, *(uint8_t*)queue_top(out)))) return ret;
334
        queue_pop(out);
335
    }
336 249 up20180642
    return SUCCESS;
337
}
338 275 up20180642
static int nctp_transmit(void){
339
    if(!queue_empty(out)){
340
        int ret = uart_send_char(COM1_ADDR, *(uint8_t*)queue_top(out));
341
        queue_pop(out);
342
        return ret;
343
    }else return SUCCESS;
344 269 up20180642
}
345 278 up20180642
346 287 up20180642
static void nctp_process_received(){
347 344 up20180642
    uint16_t sz = 0;{
348
        uint8_t sz0 = *(uint8_t*)queue_top(in); free(queue_top(in)); queue_pop(in);
349
        uint8_t sz1 = *(uint8_t*)queue_top(in); free(queue_top(in)); queue_pop(in);
350
        *((uint8_t*)(&sz)+0) = sz0;
351
        *((uint8_t*)(&sz)+1) = sz1;
352
    }
353
    uint8_t *p = malloc(sz*sizeof(uint8_t));
354
    for(uint16_t i = 0; i < sz; ++i){
355
        p[i] = *(uint8_t*)queue_top(in);
356 275 up20180642
        free(queue_top(in)); queue_pop(in);
357 344 up20180642
    }
358
    if(process != NULL) process(p, sz);
359 287 up20180642
    free(p);
360 275 up20180642
}
361 344 up20180642
362
static int num_bytes_to_receive = 0;
363
static uint16_t szbytes_to_receive = 0;
364
static uint8_t size0 = 0;
365 275 up20180642
static int nctp_receive(void){
366 249 up20180642
    int ret;
367 261 up20180642
    uint8_t c;
368 344 up20180642
    int counter_to_process = 0;
369
370 275 up20180642
    while(uart_receiver_ready(COM1_ADDR)){
371
        if((ret = uart_get_char(COM1_ADDR, &c))) return ret;
372
        uint8_t *tmp = malloc(sizeof(uint8_t)); *tmp = c;
373 344 up20180642
374 275 up20180642
        queue_push(in, tmp);
375 344 up20180642
376
        if       (szbytes_to_receive){ // gotta receive 2nd size byte and update num_bytes
377
            *((uint8_t*)(&num_bytes_to_receive)+0) = size0;
378
            *((uint8_t*)(&num_bytes_to_receive)+1) = c;
379
            szbytes_to_receive = 0;
380
        } else if(num_bytes_to_receive > 0){
381
            /* Now I know there are no more size bytes to receive.
382
             * If there are normal bytes to receive*/
383
             --num_bytes_to_receive;
384
             if(num_bytes_to_receive == 0) ++counter_to_process;
385
        } else {
386
            /* Now I know I am not expecting anything.
387
             * The fact I received something means it is the 1st size byte */
388
             size0 = c;
389
             szbytes_to_receive = 1;
390
        }
391 261 up20180642
    }
392 344 up20180642
    while(counter_to_process-- > 0) nctp_process_received();
393 275 up20180642
    return SUCCESS;
394 249 up20180642
}
395 275 up20180642
396 323 up20180642
static int nctp_ih_err = SUCCESS;
397
int (nctp_get_ih_error)(void){ return nctp_ih_err; }
398 275 up20180642
void nctp_ih(void){
399
    uint8_t iir;
400
    if((nctp_ih_err = uart_get_iir(COM1_ADDR, &iir))) return;
401
    if(UART_GET_IF_INT_PEND(iir)){
402
        switch(UART_GET_INT_PEND(iir)){
403 277 up20180642
            case uart_int_rx: nctp_receive (); break;
404
            case uart_int_tx: nctp_transmit(); break;
405 324 up20180642
            case uart_int_receiver_line_stat: break;
406
            case uart_int_modem_stat: break;
407
            case uart_int_char_timeout_fifo: break;
408
            //default: break;
409 275 up20180642
        }
410
    }
411 269 up20180642
}