UDI/drivers/uart_16c550/uart16c550.c

   1 /*
   2  * UDI Ne2000 NIC Driver
   3  * By John Hodge (thePowersGang)
   4  *
   5  * uart16c550.c
   6  * - UDI initialisation
   7  */
   8 #include <udi.h>
   9 #include <udi_physio.h>
  10 #include "uart16c550_common.h"
  11
  12
  13 #include "uart16c550_pio.h"
  14
  15 #define __EXPJOIN(a,b)  a##b
  16 #define _EXPJOIN(a,b)   __EXPJOIN(a,b)
  17 #define _EXPLODE(params...)     params
  18 #define _ADDGCB(params...)      (udi_cb_t *gcb, params)
  19 #define CONTIN(suffix, call, args, params)      extern void _EXPJOIN(suffix##__,__LINE__) _ADDGCB params;\
  20         call( _EXPJOIN(suffix##__,__LINE__), gcb, _EXPLODE args); } \
  21         void _EXPJOIN(suffix##__,__LINE__) _ADDGCB params { \
  22         rdata_t *rdata = gcb->context;
  23
  24 // --- Management Metalang
  25 void uart_usage_ind(udi_usage_cb_t *cb, udi_ubit8_t resource_level)
  26 {
  27         rdata_t *rdata = UDI_GCB(cb)->context;
  28
  29         // TODO: Set up region data
  30
  31         udi_usage_res(cb);
  32 }
  33
  34 void uart_enumerate_req(udi_enumerate_cb_t *cb, udi_ubit8_t enumeration_level)
  35 {
  36         rdata_t *rdata = UDI_GCB(cb)->context;
  37         udi_instance_attr_list_t *attr_list = cb->attr_list;
  38
  39         switch(enumeration_level)
  40         {
  41         case UDI_ENUMERATE_START:
  42         case UDI_ENUMERATE_START_RESCAN:
  43                 DPT_SET_ATTR_STRING(attr_list, "gio_type", "uart", 4);
  44                 attr_list ++;
  45                 cb->attr_valid_length = attr_list - cb->attr_list;
  46                 udi_enumerate_ack(cb, UDI_ENUMERATE_OK, UART_OPS_GIO);
  47                 break;
  48         case UDI_ENUMERATE_NEXT:
  49                 udi_enumerate_ack(cb, UDI_ENUMERATE_DONE, 0);
  50                 break;
  51         }
  52 }
  53 void uart_devmgmt_req(udi_mgmt_cb_t *cb, udi_ubit8_t mgmt_op, udi_ubit8_t parent_ID)
  54 {
  55 }
  56 void uart_final_cleanup_req(udi_mgmt_cb_t *cb)
  57 {
  58 }
  59 // ---
  60 void uart_bus_dev_channel_event_ind(udi_channel_event_cb_t *cb);
  61 void uart_bus_dev_bus_bind_ack(udi_bus_bind_cb_t *cb, udi_dma_constraints_t dma_constraints, udi_ubit8_t perferred_endianness, udi_status_t status);
  62 void uart_bus_dev_bind__pio_map(udi_cb_t *cb, udi_pio_handle_t new_pio_handle);
  63 void uart_bus_dev_bind__intr_chanel(udi_cb_t *gcb, udi_channel_t new_channel);
  64 void uart_bus_dev_bus_unbind_ack(udi_bus_bind_cb_t *cb);
  65
  66 void uart_bus_dev_channel_event_ind(udi_channel_event_cb_t *cb)
  67 {
  68         udi_cb_t        *gcb = UDI_GCB(cb);
  69         rdata_t *rdata = gcb->context;
  70
  71         switch(cb->event)
  72         {
  73         case UDI_CHANNEL_CLOSED:
  74                 break;
  75         case UDI_CHANNEL_BOUND: {
  76                 rdata->active_cb = gcb;
  77                 udi_bus_bind_cb_t *bus_bind_cb = UDI_MCB(cb->params.parent_bound.bind_cb, udi_bus_bind_cb_t);
  78                 udi_bus_bind_req( bus_bind_cb );
  79                 // continue at uart_bus_dev_bus_bind_ack
  80                 return; }
  81         }
  82 }
  83 void uart_bus_dev_bus_bind_ack(udi_bus_bind_cb_t *cb,
  84         udi_dma_constraints_t dma_constraints, udi_ubit8_t perferred_endianness, udi_status_t status)
  85 {
  86         udi_cb_t        *gcb = UDI_GCB(cb);
  87         rdata_t *rdata = gcb->context;
  88
  89         // Set up PIO handles
  90         rdata->init.pio_index = -1;
  91         uart_bus_dev_bind__pio_map(gcb, UDI_NULL_PIO_HANDLE);
  92         // V V V V
  93 }
  94 void uart_bus_dev_bind__pio_map(udi_cb_t *gcb, udi_pio_handle_t new_pio_handle)
  95 {
  96         rdata_t *rdata = gcb->context;
  97         if( rdata->init.pio_index != -1 )
  98         {
  99                 rdata->pio_handles[rdata->init.pio_index] = new_pio_handle;
 100         }
 101
 102         rdata->init.pio_index ++;
 103         if( rdata->init.pio_index < N_PIO )
 104         {
 105                 udi_pio_map(uart_bus_dev_bind__pio_map, gcb,
 106                         UDI_PCI_BAR_0, 0, 0x8,  // TODO: Use system bus index and offset
 107                         uart_pio_ops[rdata->init.pio_index].trans_list,
 108                         uart_pio_ops[rdata->init.pio_index].list_length,
 109                         UDI_PIO_LITTLE_ENDIAN, 0, 0
 110                         );
 111                 return ;
 112         }
 113
 114         // Spawn the interrupt channel
 115         CONTIN( uart_bus_dev_bind, udi_channel_spawn, (gcb->channel, 0, UART_OPS_IRQ, rdata),
 116                 (udi_channel_t new_channel))
 117
 118         rdata->interrupt_channel = new_channel;
 119
 120         // Allocate an RX buffer
 121         CONTIN( uart_bus_dev_bind, udi_buf_write, (NULL, RX_BUFFER_SIZE, NULL, 0, 0, UDI_NULL_BUF_PATH),
 122                 (udi_buf_t *new_buf));
 123         if( !new_buf )
 124         {
 125                 // Oh...
 126                 udi_channel_event_complete( UDI_MCB(rdata->active_cb, udi_channel_event_cb_t),
 127                         UDI_STAT_RESOURCE_UNAVAIL );
 128                 return ;
 129         }
 130         rdata->rx_buffer = new_buf;
 131
 132         // Create interrupt CB
 133         CONTIN( uart_bus_dev_bind, udi_cb_alloc, (UART_CB_INTR, gcb->channel),
 134                 (udi_cb_t *new_cb))
 135         if( !new_cb )
 136         {
 137                 // Oh...
 138                 udi_channel_event_complete( UDI_MCB(rdata->active_cb, udi_channel_event_cb_t),
 139                         UDI_STAT_RESOURCE_UNAVAIL );
 140                 return ;
 141         }
 142         udi_intr_attach_cb_t    *intr_cb = UDI_MCB(new_cb, udi_intr_attach_cb_t);
 143         intr_cb->interrupt_idx = 0;
 144         intr_cb->min_event_pend = 1;
 145         intr_cb->preprocessing_handle = rdata->pio_handles[PIO_INTR];
 146
 147         // Attach interrupt
 148         udi_intr_attach_req(intr_cb);
 149         // continued in uart_bus_dev_intr_attach_ack
 150 }
 151 void uart_bus_dev_bus_unbind_ack(udi_bus_bind_cb_t *cb)
 152 {
 153 }
 154 void uart_bus_dev_intr_attach_ack(udi_intr_attach_cb_t *intr_attach_cb, udi_status_t status)
 155 {
 156         udi_cb_t        *gcb = UDI_GCB(intr_attach_cb);
 157         rdata_t *rdata = gcb->context;
 158
 159         // TODO: Allocate interrupt cbs
 160         CONTIN(uart_bus_dev_intr_attach_ack, udi_cb_alloc, (UART_CB_INTR_EVENT, rdata->interrupt_channel),
 161                 (udi_cb_t *new_cb))
 162
 163         udi_intr_event_cb_t *cb = UDI_MCB(new_cb, udi_intr_event_cb_t);
 164         udi_intr_event_rdy(cb);
 165
 166         udi_channel_event_cb_t  *channel_cb = UDI_MCB(rdata->active_cb, udi_channel_event_cb_t);
 167
 168         udi_channel_event_complete(channel_cb, UDI_OK);
 169         // = = = = =
 170 }
 171 void uart_bus_dev_intr_detach_ack(udi_intr_detach_cb_t *intr_detach_cb)
 172 {
 173 }
 174 // ---
 175 void uart_bus_irq_channel_event_ind(udi_channel_event_cb_t *cb)
 176 {
 177 }
 178 void uart_bus_irq_intr_event_ind(udi_intr_event_cb_t *cb, udi_ubit8_t flags)
 179 {
 180         udi_debug_printf("%s: flags=%x, intr_result=%x\n", __func__, flags, cb->intr_result);
 181         if( cb->intr_result & 0x01 )
 182         {
 183                 //ne2k_intr__rx_ok( UDI_GCB(cb) );
 184         }
 185         // TODO: TX IRQs
 186         udi_intr_event_rdy(cb);
 187 }
 188 // ---
 189 void uart_gio_prov_channel_event_ind(udi_channel_event_cb_t *cb);
 190 void uart_gio_prov_bind_req(udi_gio_bind_cb_t *cb);
 191 void uart_gio_prov_xfer_req(udi_gio_xfer_cb_t *cb);
 192 void uart_gio_read_complete(udi_cb_t *gcb, udi_buf_t *new_buf);
 193 void uart_gio_write_complete(udi_cb_t *gcb, udi_buf_t *new_buf, udi_status_t status, udi_ubit16_t res);
 194 void uart_gio_prov_event_res(udi_gio_event_cb_t *cb);
 195
 196 void uart_gio_prov_channel_event_ind(udi_channel_event_cb_t *cb)
 197 {
 198 }
 199 void uart_gio_prov_bind_req(udi_gio_bind_cb_t *cb)
 200 {
 201         udi_gio_bind_ack(cb, 0, 0, UDI_OK);
 202 }
 203 void uart_gio_prov_unbind_req(udi_gio_bind_cb_t *cb)
 204 {
 205         udi_gio_unbind_ack(cb);
 206 }
 207 void uart_gio_prov_xfer_req(udi_gio_xfer_cb_t *cb)
 208 {
 209         udi_cb_t        *gcb = UDI_GCB(cb);
 210         rdata_t *rdata = gcb->context;
 211         switch(cb->op)
 212         {
 213         case UDI_GIO_OP_READ:
 214                 // Read from local FIFO
 215                 if( rdata->rx_bytes < cb->data_buf->buf_size ) {
 216                         // Local FIFO was empty
 217                         udi_gio_xfer_nak(cb, UDI_STAT_DATA_UNDERRUN);
 218                 }
 219                 else {
 220                         udi_buf_copy(uart_gio_read_complete, gcb,
 221                                 rdata->rx_buffer,
 222                                 0, cb->data_buf->buf_size,
 223                                 cb->data_buf,
 224                                 0, cb->data_buf->buf_size,
 225                                 UDI_NULL_BUF_PATH);
 226                 }
 227                 break;
 228         case UDI_GIO_OP_WRITE:
 229                 // Send to device
 230                 udi_pio_trans(uart_gio_write_complete, gcb,
 231                         rdata->pio_handles[PIO_TX], 0, cb->data_buf, &cb->data_buf->buf_size);
 232                 break;
 233         default:
 234                 udi_gio_xfer_nak(cb, UDI_STAT_NOT_SUPPORTED);
 235                 break;
 236         }
 237 }
 238 void uart_gio_read_complete(udi_cb_t *gcb, udi_buf_t *new_buf)
 239 {
 240         rdata_t *rdata = gcb->context;
 241         udi_gio_xfer_cb_t       *cb = UDI_MCB(gcb, udi_gio_xfer_cb_t);
 242         cb->data_buf = new_buf;
 243         // Delete read bytes from the RX buffer
 244         CONTIN(uart_gio_read_complete, udi_buf_write, (NULL, 0, rdata->rx_buffer, 0, cb->data_buf->buf_size, UDI_NULL_BUF_PATH),
 245                 (udi_buf_t *new_buf))
 246         udi_gio_xfer_cb_t       *cb = UDI_MCB(gcb, udi_gio_xfer_cb_t);
 247         rdata->rx_buffer = new_buf;
 248         udi_gio_xfer_ack(cb);
 249 }
 250 void uart_gio_write_complete(udi_cb_t *gcb, udi_buf_t *new_buf, udi_status_t status, udi_ubit16_t res)
 251 {
 252         udi_gio_xfer_cb_t       *cb = UDI_MCB(gcb, udi_gio_xfer_cb_t);
 253         cb->data_buf = new_buf;
 254         udi_gio_xfer_ack(cb);
 255 }
 256 void uart_gio_prov_event_res(udi_gio_event_cb_t *cb)
 257 {
 258 }
 259
 260 // ====================================================================
 261 // - Management ops
 262 udi_mgmt_ops_t  uart_mgmt_ops = {
 263         uart_usage_ind,
 264         uart_enumerate_req,
 265         uart_devmgmt_req,
 266         uart_final_cleanup_req
 267 };
 268 udi_ubit8_t     uart_mgmt_op_flags[4] = {0,0,0,0};
 269 // - Bus Ops
 270 udi_bus_device_ops_t    uart_bus_dev_ops = {
 271         uart_bus_dev_channel_event_ind,
 272         uart_bus_dev_bus_bind_ack,
 273         uart_bus_dev_bus_unbind_ack,
 274         uart_bus_dev_intr_attach_ack,
 275         uart_bus_dev_intr_detach_ack
 276 };
 277 udi_ubit8_t     uart_bus_dev_ops_flags[5] = {0};
 278 // - IRQ Ops
 279 udi_intr_handler_ops_t  uart_bus_irq_ops = {
 280         uart_bus_irq_channel_event_ind,
 281         uart_bus_irq_intr_event_ind
 282 };
 283 udi_ubit8_t     uart_bus_irq_ops_flags[2] = {0};
 284 // - GIO provider ops
 285 udi_gio_provider_ops_t  uart_gio_prov_ops = {
 286         uart_gio_prov_channel_event_ind,
 287         uart_gio_prov_bind_req,
 288         uart_gio_prov_unbind_req,
 289         uart_gio_prov_xfer_req,
 290         uart_gio_prov_event_res
 291 };
 292 udi_ubit8_t     uart_gio_prov_ops_flags[5] = {0};
 293 // --
 294 udi_primary_init_t      uart_pri_init = {
 295         .mgmt_ops = &uart_mgmt_ops,
 296         .mgmt_op_flags = uart_mgmt_op_flags,
 297         .mgmt_scratch_requirement = 0,
 298         .enumeration_attr_list_length = 4,
 299         .rdata_size = sizeof(rdata_t),
 300         .child_data_size = 0,
 301         .per_parent_paths = 0
 302 };
 303 udi_ops_init_t  uart_ops_list[] = {
 304         {
 305                 UART_OPS_DEV, UART_META_BUS, UDI_BUS_DEVICE_OPS_NUM,
 306                 0,
 307                 (udi_ops_vector_t*)&uart_bus_dev_ops,
 308                 uart_bus_dev_ops_flags
 309         },
 310         {
 311                 UART_OPS_IRQ, UART_META_BUS, UDI_BUS_INTR_HANDLER_OPS_NUM,
 312                 0,
 313                 (udi_ops_vector_t*)&uart_bus_irq_ops,
 314                 uart_bus_irq_ops_flags
 315         },
 316         {
 317                 UART_OPS_GIO, UART_META_GIO, UDI_GIO_PROVIDER_OPS_NUM,
 318                 0,
 319                 (udi_ops_vector_t*)&uart_gio_prov_ops,
 320                 uart_gio_prov_ops_flags
 321         },
 322         {0}
 323 };
 324 udi_cb_init_t uart_cb_init_list[] = {
 325         {UART_CB_BUS_BIND,   UART_META_BUS, UDI_BUS_BIND_CB_NUM, 0, 0,NULL},
 326         {UART_CB_INTR,       UART_META_BUS, UDI_BUS_INTR_ATTACH_CB_NUM, 0, 0,NULL},
 327         {UART_CB_INTR_EVENT, UART_META_BUS, UDI_BUS_INTR_EVENT_CB_NUM, 0, 0,NULL},
 328         {0}
 329 };
 330 const udi_init_t        udi_init_info = {
 331         .primary_init_info = &uart_pri_init,
 332         .ops_init_list = uart_ops_list,
 333         .cb_init_list = uart_cb_init_list,
 334 };