KernelLand/Modules/Interfaces/UDI/trans/bus_pci.c

   1 /*
   2  * Acess2 UDI Layer
   3  * - By John Hodge (thePowersGang)
   4  *
   5  * trans/bus_pci.c
   6  * - PCI Bus Driver
   7  */
   8 #define DEBUG   1
   9 #include <udi.h>
  10 #include <udi_physio.h>
  11 #include <udi_pci.h>
  12 #include <acess.h>
  13 #include <drv_pci.h>    // acess
  14 #include <udi_internal.h>
  15 #include <trans_pci.h>
  16
  17 // === MACROS ===
  18 /* Copied from http://projectudi.cvs.sourceforge.net/viewvc/projectudi/udiref/driver/udi_dpt/udi_dpt.h */
  19 #define DPT_SET_ATTR_BOOLEAN(attr, name, val)   \
  20                 udi_strcpy((attr)->attr_name, (name)); \
  21                 (attr)->attr_type = UDI_ATTR_BOOLEAN; \
  22                 (attr)->attr_length = sizeof(udi_boolean_t); \
  23                 UDI_ATTR32_SET((attr)->attr_value, (val))
  24
  25 #define DPT_SET_ATTR32(attr, name, val) \
  26                 udi_strcpy((attr)->attr_name, (name)); \
  27                 (attr)->attr_type = UDI_ATTR_UBIT32; \
  28                 (attr)->attr_length = sizeof(udi_ubit32_t); \
  29                 UDI_ATTR32_SET((attr)->attr_value, (val))
  30
  31 #define DPT_SET_ATTR_ARRAY8(attr, name, val, len) \
  32                 udi_strcpy((attr)->attr_name, (name)); \
  33                 (attr)->attr_type = UDI_ATTR_ARRAY8; \
  34                 (attr)->attr_length = (len); \
  35                 udi_memcpy((attr)->attr_value, (val), (len))
  36
  37 #define DPT_SET_ATTR_STRING(attr, name, val, len) \
  38                 udi_strcpy((attr)->attr_name, (name)); \
  39                 (attr)->attr_type = UDI_ATTR_STRING; \
  40                 (attr)->attr_length = (len); \
  41                 udi_strncpy_rtrim((char *)(attr)->attr_value, (val), (len))
  42
  43 #define PCI_OPS_BRIDGE  1
  44 #define PCI_OPS_IRQ     2
  45
  46 #define PCI_MAX_EVENT_CBS       8
  47
  48 // === TYPES ===
  49 typedef struct
  50 {
  51         udi_init_context_t      init_context;
  52
  53         tPCIDev cur_iter;
  54 } pci_rdata_t;
  55
  56 typedef struct
  57 {
  58         udi_child_chan_context_t        child_chan_context;
  59
  60         udi_channel_t   interrupt_channel;
  61         struct {
  62                 tPAddr  paddr;
  63                 void    *vaddr;
  64                 size_t  length;
  65         } bars[6];
  66
  67          int    interrupt_handle;
  68
  69         udi_pio_handle_t        intr_preprocessing;
  70         udi_intr_event_cb_t     *event_cbs[PCI_MAX_EVENT_CBS];
  71          int    event_cb_wr_ofs;
  72          int    event_cb_rd_ofs;
  73 } pci_child_chan_context_t;
  74
  75 // === PROTOTYPES ===
  76 void    pci_usage_ind(udi_usage_cb_t *cb, udi_ubit8_t resource_level);
  77 void    pci_enumerate_req(udi_enumerate_cb_t *cb, udi_ubit8_t enumeration_level);
  78 void    pci_devmgmt_req(udi_mgmt_cb_t *cb, udi_ubit8_t mgmt_op, udi_ubit8_t parent_ID);
  79 void    pci_final_cleanup_req(udi_mgmt_cb_t *cb);
  80
  81 void    pci_bridge_ch_event_ind(udi_channel_event_cb_t *cb);
  82 void    pci_unbind_req(udi_bus_bind_cb_t *cb);
  83 void    pci_bind_req_op(udi_bus_bind_cb_t *cb);
  84 void    pci_intr_attach_req(udi_intr_attach_cb_t *cb);
  85 void    pci_intr_attach_req__channel_spawned(udi_cb_t *gcb, udi_channel_t new_channel);
  86 void    pci_intr_detach_req(udi_intr_detach_cb_t *cb);
  87
  88 void    pci_intr_ch_event_ind(udi_channel_event_cb_t *cb);
  89 void    pci_intr_event_rdy(udi_intr_event_cb_t *cb);
  90 void    pci_intr_handler(int irq, void *void_context);
  91 void    pci_intr_handle__trans_done(udi_cb_t *gcb, udi_buf_t *new_buf, udi_status_t status, udi_ubit16_t result);
  92
  93 // - Hook to physio (UDI doesn't define these)
  94  int    pci_pio_get_regset(udi_cb_t *gcb, udi_ubit32_t regset_idx, void **baseptr, size_t *lenptr);
  95
  96 // === CODE ===
  97 void pci_usage_ind(udi_usage_cb_t *cb, udi_ubit8_t resource_level)
  98 {
  99         pci_rdata_t     *rdata = UDI_GCB(cb)->context;
 100
 101         switch(cb->meta_idx)
 102         {
 103         case 1: // mgmt
 104                 break;
 105         }
 106
 107         switch(resource_level)
 108         {
 109         case UDI_RESOURCES_CRITICAL:
 110         case UDI_RESOURCES_LOW:
 111         case UDI_RESOURCES_NORMAL:
 112         case UDI_RESOURCES_PLENTIFUL:
 113                 break;
 114         }
 115
 116         // TODO: Initialise rdata
 117         rdata->cur_iter = -1;
 118
 119         udi_usage_res(cb);
 120 }
 121 void pci_enumerate_req(udi_enumerate_cb_t *cb, udi_ubit8_t enumeration_level)
 122 {
 123         pci_rdata_t     *rdata = UDI_GCB(cb)->context;
 124         switch(enumeration_level)
 125         {
 126         case UDI_ENUMERATE_START:
 127         case UDI_ENUMERATE_START_RESCAN:
 128                 rdata->cur_iter = -1;
 129         case UDI_ENUMERATE_NEXT:
 130                 // TODO: Filters
 131                 if( (rdata->cur_iter = PCI_GetDeviceByClass(0,0, rdata->cur_iter)) == -1 )
 132                 {
 133                         udi_enumerate_ack(cb, UDI_ENUMERATE_DONE, 0);
 134                 }
 135                 else
 136                 {
 137                         udi_instance_attr_list_t *attr_list = cb->attr_list;
 138                         Uint16  ven, dev;
 139                         Uint32  class;
 140                         PCI_GetDeviceInfo(rdata->cur_iter, &ven, &dev, &class);
 141                         Uint8   revision;
 142                         PCI_GetDeviceVersion(rdata->cur_iter, &revision);
 143                         Uint16  sven, sdev;
 144                         PCI_GetDeviceSubsys(rdata->cur_iter, &sven, &sdev);
 145
 146                         udi_strcpy(attr_list->attr_name, "identifier");
 147                         attr_list->attr_length = sprintf((char*)attr_list->attr_value,
 148                                 "%04x%04x%02x%04x%04x",
 149                                 ven, dev, revision, sven, sdev);
 150                         attr_list ++;
 151                         DPT_SET_ATTR_STRING(attr_list, "bus_type", "pci", 3);
 152                         attr_list ++;
 153                         DPT_SET_ATTR32(attr_list, "pci_vendor_id", ven);
 154                         attr_list ++;
 155                         DPT_SET_ATTR32(attr_list, "pci_device_id", dev);
 156                         attr_list ++;
 157
 158                         cb->attr_valid_length = attr_list - cb->attr_list;
 159                         cb->child_ID = rdata->cur_iter;
 160                         udi_enumerate_ack(cb, UDI_ENUMERATE_OK, 1);
 161                 }
 162                 break;
 163         }
 164 }
 165 void pci_devmgmt_req(udi_mgmt_cb_t *cb, udi_ubit8_t mgmt_op, udi_ubit8_t parent_ID)
 166 {
 167         UNIMPLEMENTED();
 168 }
 169 void pci_final_cleanup_req(udi_mgmt_cb_t *cb)
 170 {
 171         UNIMPLEMENTED();
 172 }
 173
 174 void pci_bridge_ch_event_ind(udi_channel_event_cb_t *cb)
 175 {
 176         UNIMPLEMENTED();
 177 }
 178 void pci_bind_req(udi_bus_bind_cb_t *cb)
 179 {
 180         // TODO: "Lock" PCI device
 181
 182         // TODO: DMA constraints
 183         udi_bus_bind_ack(cb, 0, UDI_DMA_LITTLE_ENDIAN, UDI_OK);
 184 }
 185 void pci_unbind_req(udi_bus_bind_cb_t *cb)
 186 {
 187         UNIMPLEMENTED();
 188 }
 189 void pci_intr_attach_req(udi_intr_attach_cb_t *cb)
 190 {
 191         pci_child_chan_context_t *context = UDI_GCB(cb)->context;
 192
 193         ASSERT(cb->interrupt_idx == 0);
 194
 195         context->intr_preprocessing = cb->preprocessing_handle;
 196         // Check if interrupt is already bound
 197         if( !UDI_HANDLE_IS_NULL(context->interrupt_channel, udi_channel_t) )
 198         {
 199                 udi_intr_attach_ack(cb, UDI_OK);
 200                 return ;
 201         }
 202         // Create a channel
 203         udi_channel_spawn(pci_intr_attach_req__channel_spawned, UDI_GCB(cb),
 204                 cb->gcb.channel, cb->interrupt_idx, PCI_OPS_IRQ, context);
 205 }
 206 void pci_intr_attach_req__channel_spawned(udi_cb_t *gcb, udi_channel_t new_channel)
 207 {
 208         udi_intr_attach_cb_t *cb = UDI_MCB(gcb, udi_intr_attach_cb_t);
 209         pci_child_chan_context_t *context = UDI_GCB(cb)->context;
 210
 211         if( UDI_HANDLE_IS_NULL(new_channel, udi_channel_t) )
 212         {
 213                 // oops
 214                 return ;
 215         }
 216
 217         context->interrupt_channel = new_channel;
 218
 219         context->interrupt_handle = IRQ_AddHandler(
 220                 PCI_GetIRQ(context->child_chan_context.child_ID),
 221                 pci_intr_handler, new_channel);
 222
 223         udi_intr_attach_ack(cb, UDI_OK);
 224 }
 225 void pci_intr_detach_req(udi_intr_detach_cb_t *cb)
 226 {
 227         UNIMPLEMENTED();
 228 }
 229
 230 void pci_intr_ch_event_ind(udi_channel_event_cb_t *cb)
 231 {
 232         UNIMPLEMENTED();
 233 }
 234 void pci_intr_event_rdy(udi_intr_event_cb_t *cb)
 235 {
 236         pci_child_chan_context_t        *context = UDI_GCB(cb)->context;
 237         if( context->event_cbs[context->event_cb_wr_ofs] )
 238         {
 239                 // oops, overrun.
 240                 return ;
 241         }
 242         context->event_cbs[context->event_cb_wr_ofs++] = cb;
 243         if( context->event_cb_wr_ofs == PCI_MAX_EVENT_CBS )
 244                 context->event_cb_wr_ofs = 0;
 245 }
 246
 247 void pci_intr_handler(int irq, void *void_context)
 248 {
 249         pci_child_chan_context_t *context = void_context;
 250
 251         if( context->event_cb_rd_ofs == context->event_cb_wr_ofs ) {
 252                 // Dropped
 253                 return ;
 254         }
 255
 256         udi_intr_event_cb_t *cb = context->event_cbs[context->event_cb_rd_ofs];
 257         context->event_cbs[context->event_cb_rd_ofs] = NULL;
 258         context->event_cb_rd_ofs ++;
 259         if( context->event_cb_rd_ofs == PCI_MAX_EVENT_CBS )
 260                 context->event_cb_rd_ofs = 0;
 261
 262         if( UDI_HANDLE_IS_NULL(context->intr_preprocessing, udi_pio_handle_t) )
 263         {
 264                 udi_intr_event_ind(cb, 0);
 265         }
 266         else
 267         {
 268                 // Processing
 269                 // - no event info, so mem_ptr=NULL
 270                 udi_pio_trans(pci_intr_handle__trans_done, UDI_GCB(cb),
 271                         context->intr_preprocessing, 1, cb->event_buf, NULL);
 272         }
 273 }
 274
 275 void pci_intr_handle__trans_done(udi_cb_t *gcb, udi_buf_t *new_buf, udi_status_t status, udi_ubit16_t result)
 276 {
 277         udi_intr_event_cb_t *cb = UDI_MCB(gcb, udi_intr_event_cb_t);
 278
 279         cb->intr_result = result;
 280
 281         udi_intr_event_ind(cb, UDI_INTR_PREPROCESSED);
 282 }
 283
 284 // - physio hooks
 285 udi_status_t pci_pio_do_io(uint32_t child_ID, udi_ubit32_t regset_idx, udi_ubit32_t ofs, udi_ubit8_t len,
 286         void *data, bool isOutput)
 287 {
 288 //      LOG("child_ID=%i, regset_idx=%i,ofs=0x%x,len=%i,data=%p,isOutput=%b",
 289 //              child_ID, regset_idx, ofs, len, data, isOutput);
 290         tPCIDev pciid = child_ID;
 291         // TODO: Cache child mappings
 292
 293         switch(regset_idx)
 294         {
 295         case UDI_PCI_CONFIG_SPACE:
 296                 // TODO:
 297                 return UDI_STAT_NOT_SUPPORTED;
 298         case UDI_PCI_BAR_0 ... UDI_PCI_BAR_5: {
 299                 Uint32 bar = PCI_GetBAR(pciid, regset_idx);
 300                 if(bar & 1)
 301                 {
 302                         // IO BAR
 303                         bar &= ~3;
 304                         #define _IO(fc, type) do {\
 305                                 if( isOutput ) { \
 306                                         LOG("out"#fc"(0x%x, 0x%x)",bar+ofs,*(type*)data);\
 307                                         out##fc(bar+ofs, *(type*)data); \
 308                                 } \
 309                                 else { \
 310                                         *(type*)data = in##fc(bar+ofs); \
 311                                         LOG("in"#fc"(0x%x) = 0x%x",bar+ofs,*(type*)data);\
 312                                 }\
 313                                 } while(0)
 314                         switch(len)
 315                         {
 316                         case UDI_PIO_1BYTE:     _IO(b, udi_ubit8_t);    return UDI_OK;
 317                         case UDI_PIO_2BYTE:     _IO(w, udi_ubit16_t);   return UDI_OK;
 318                         case UDI_PIO_4BYTE:     _IO(d, udi_ubit32_t);   return UDI_OK;
 319                         //case UDI_PIO_8BYTE:   _IO(q, uint64_t);       return UDI_OK;
 320                         default:
 321                                 return UDI_STAT_NOT_SUPPORTED;
 322                         }
 323                         #undef _IO
 324                 }
 325                 else
 326                 {
 327                         // Memory BAR
 328                         //Uint64 longbar = PCI_GetValidBAR(pciid, regset_idx, PCI_BARTYPE_MEM);
 329                         return UDI_STAT_NOT_SUPPORTED;
 330                 }
 331                 break; }
 332         default:
 333                 return UDI_STAT_NOT_UNDERSTOOD;
 334         }
 335 }
 336
 337 // === UDI Functions ===
 338 udi_mgmt_ops_t  pci_mgmt_ops = {
 339         pci_usage_ind,
 340         pci_enumerate_req,
 341         pci_devmgmt_req,
 342         pci_final_cleanup_req
 343 };
 344 udi_ubit8_t     pci_mgmt_op_flags[4] = {0,0,0,0};
 345 udi_bus_bridge_ops_t    pci_bridge_ops = {
 346         pci_bridge_ch_event_ind,
 347         pci_bind_req,
 348         pci_unbind_req,
 349         pci_intr_attach_req,
 350         pci_intr_detach_req
 351 };
 352 udi_ubit8_t     pci_bridge_op_flags[5] = {0,0,0,0,0};
 353 udi_intr_dispatcher_ops_t       pci_irq_ops = {
 354         pci_intr_ch_event_ind,
 355         pci_intr_event_rdy
 356 };
 357 udi_ubit8_t     pci_irq_ops_flags[2] = {0,0};
 358 udi_primary_init_t      pci_pri_init = {
 359         .mgmt_ops = &pci_mgmt_ops,
 360         .mgmt_op_flags = pci_mgmt_op_flags,
 361         .mgmt_scratch_requirement = 0,
 362         .enumeration_attr_list_length = 4,
 363         .rdata_size = sizeof(pci_rdata_t),
 364         .child_data_size = 0,
 365         .per_parent_paths = 0
 366 };
 367 udi_ops_init_t  pci_ops_list[] = {
 368         {
 369                 PCI_OPS_BRIDGE, 1, UDI_BUS_BRIDGE_OPS_NUM,
 370                 sizeof(pci_child_chan_context_t),
 371                 (udi_ops_vector_t*)&pci_bridge_ops,
 372                 pci_bridge_op_flags
 373         },
 374         {
 375                 PCI_OPS_IRQ, 1, UDI_BUS_INTR_DISPATCH_OPS_NUM,
 376                 0,
 377                 (udi_ops_vector_t*)&pci_irq_ops,
 378                 pci_irq_ops_flags
 379         },
 380         {0}
 381 };
 382 udi_init_t      pci_init = {
 383         .primary_init_info = &pci_pri_init,
 384         .ops_init_list = pci_ops_list
 385 };
 386 const char      pci_udiprops[] =
 387         "properties_version 0x101\0"
 388         "message 1 Acess2 Kernel\0"
 389         "message 2 John Hodge ([email protected])\0"
 390         "message 3 Acess2 PCI Bus\0"
 391         "supplier 1\0"
 392         "contact 2\0"
 393         "name 3\0"
 394         "module acess_pci\0"
 395         "shortname acesspci\0"
 396         "requires udi 0x101\0"
 397         "provides udi_bridge 0x101\0"
 398         "meta 1 udi_bridge\0"
 399         "enumerates 4 0 100 1 bus_name string pci\0"
 400         "region 0\0"
 401         "child_bind_ops 1 0 1\0"
 402         "";
 403 size_t  pci_udiprops_size = sizeof(pci_udiprops);