drmGeneration.c

   1 /**
   2  * @file drmGeneration.c
   3  *
   4  * @brief Generates a specific PCI device Driver/Simulator code
   5  *
   6  * @author Copyright (C) 2002 CERN. Stuart Baird
   7  * @author Copyright (C) 2003 CERN. Alain Gagnaire
   8  * @author Copyright (C) 2003 - 2010 CERN. Georgievskiy Yury <ygeorgie@cern.ch>
   9  *
  10  * @date Created on 27/02/2004
  11  *
  12  * @section license_sec License
  13  *          Released under the GPL
  14  */
  15 #include "driverGen.h"
  16
  17 static void GenerateDrmInfo(PciInfo_t *, BlockDef_t *, int);
  18 static void BuildDrmHeaderFile(int, RegisterDef_t *, int, BlockDef_t *, int);
  19 static void BuildDrmStatics(BlockDef_t *, int, FILE *, int);
  20 static void BuildDrmDrvrFile(RegisterDef_t *, int, BlockDef_t *, int);
  21 static void BuildDrmSimFile(RegisterDef_t *, int, BlockDef_t *, int);
  22
  23 /**
  24  * @brief Generates the entire driver source code from scratch, including
  25  *        user-defined files.
  26  *
  27  * @param registers    - register description
  28  * @param numRegisters - register amount
  29  * @param blocks       - block description
  30  * @param numBlocks    - block amount
  31  * @param pciInfo      - @e pci description
  32  *
  33  * @return void
  34  */
  35 void GenerateDrmDriver(RegisterDef_t * registers, int numRegisters,
  36                        BlockDef_t * blocks, int numBlocks, PciInfo_t * pciInfo)
  37 {
  38         char *system = TranslationGetSysLower();
  39
  40         /* First, build-up major source code of the driver */
  41         GenerateDrmCore(registers, numRegisters, blocks, numBlocks, pciInfo);
  42
  43         /* Now build-up user-defined driver files for the current module */
  44         printf("Building %s user entry poins.\n", system);
  45         BuildUserPartDrvrCode();
  46 }
  47
  48 /**
  49  * @brief Generates major source code of the driver, excluding the generation
  50  *        of user-defined files.
  51  *
  52  * @param registers    - register description
  53  * @param numRegisters - register amoun
  54  * @param blocks       - block description
  55  * @param numBlocks    - block amoun
  56  * @param pciInfo      - @e pci description
  57  *
  58  * @return void
  59  */
  60 void GenerateDrmCore(RegisterDef_t * registers, int numRegisters,
  61                      BlockDef_t * blocks, int numBlocks, PciInfo_t * pciInfo)
  62 {
  63         char *system = TranslationGetSysLower();
  64
  65   /*-=-=-=-=-=-=-=-=-=-=-=-=- 00. PCI driver. =-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=*/
  66         printf("Building %s driver's source code\n", system);
  67         /* Header file for driver. */
  68         BuildDrmHeaderFile(DRIVER_FT, registers, numRegisters, blocks,
  69                            numBlocks);
  70         /* Driver source. */
  71         BuildDrmDrvrFile(registers, numRegisters, blocks, numBlocks);
  72
  73   /*-=-=-=-=-=-=-=-=-=-=-= 01. PCI simulator. -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-*/
  74         printf("Building %s driver's simulator source code.\n", system);
  75         /* Header file for simulator. */
  76         BuildDrmHeaderFile(SIM_FT, registers, numRegisters, blocks, numBlocks);
  77         /* Simulator source. */
  78         BuildDrmSimFile(registers, numRegisters, blocks, numBlocks);
  79
  80   /*-=-=-=-=-=-=-=-=-02. Driver/Simulator registers r/w operations-=-=-=-=-=-*/
  81         /* TODO. Take care of the third parameter! It's incorrect in this caseQ */
  82         BuildGetSetRegCH(registers, numRegisters, NULL);
  83
  84   /*--------------------03. Libraries---------------------------------------*/
  85         printf("Building %s access library\n", system);
  86         BuildIoctlLibrary(registers, numRegisters, blocks, numBlocks);
  87
  88         /*  */
  89         printf("Building %s test program\n", system);
  90         BuildTestProgram(registers, numRegisters, blocks, numBlocks);
  91
  92   /*========XX. REGISTER DESCRIPTINON AND INFO FILE.========*/
  93         GenerateDrmInstallFilesOLD(pciInfo, blocks, numBlocks);
  94
  95         /*  */
  96         printf("Building %s makefile\n", system);
  97         BuildMakefiles();
  98 }
  99
 100 /**
 101  * @brief SHOULD BE REMOVED.
 102  *
 103  * @param pciInfo   - @e pci info
 104  * @param blocks    - block description
 105  * @param numBlocks - block amount
 106  *
 107  * @return void
 108  */
 109 void GenerateDrmInstallFilesOLD(PciInfo_t * pciInfo, BlockDef_t * blocks,
 110                                 int numBlocks)
 111 {
 112         char *system = TranslationGetModName();
 113
 114         printf("Building %s essential installation files:\n", system);
 115         printf("         Description files.\n");
 116         BuildDescsOLD(8);
 117         printf("         Instance info structure.\n");
 118         GenerateDrmInfo(pciInfo, blocks, numBlocks);
 119 }
 120
 121 /**
 122  * @brief Generate an info structure to be used by all drivers.
 123  *
 124  * @param pciInfo   - @e pci info
 125  * @param blocks    - block description
 126  * @param numBlocks - block amount
 127  *
 128  * As a PCI driver had no need of an info structure, a dummy one is used to
 129  * satisfy the LynxOS driver format.
 130  *
 131  * @return void
 132  */
 133 static void GenerateDrmInfo(PciInfo_t * pciInfo, BlockDef_t * blocks,
 134                             int numBlocks)
 135 {
 136         FILE *infoFile = OpenFile(DRIVER_FT, LOC_MODSRC, "INST/.inst");
 137
 138         fwrite(pciInfo, sizeof(pciInfo), 1, infoFile);
 139         fclose(infoFile);
 140 }
 141
 142 /**
 143  * @brief
 144  *
 145  * @param type         - driver or simulator
 146  * @param registers    - register description
 147  * @param numRegisters - register amount
 148  * @param blocks       - block description
 149  * @param numBlocks    - block amoun
 150  *
 151  * @return void
 152  */
 153 static void BuildDrmHeaderFile(int type, RegisterDef_t * registers,
 154                                int numRegisters, BlockDef_t * blocks,
 155                                int numBlocks)
 156 {
 157         FILE *headerFile;
 158
 159         TranslationReset();
 160         headerFile = OpenFile(type, LOC_INCL, ".h");
 161
 162         /* Generate the header file's head and then go to generate the rest */
 163         Translate(headerFile, "drm", "header/head.h");
 164         /* Generate the constants used for the IOCTL function */
 165         BuildIoctlConsts(registers, numRegisters, headerFile);
 166
 167         TranslationSetPlainNum(numRegisters * 2);
 168         Translate(headerFile, "drm", "header/configConst.h");
 169         /* Generate the statics, info and block structures. */
 170         BuildCommonBlocks(type, registers, numRegisters, headerFile);
 171         BuildDrmStatics(blocks, numBlocks, headerFile, type);
 172
 173         fclose(headerFile);
 174 }
 175
 176 /**
 177  * @brief
 178  *
 179  * @param blocks     - block description
 180  * @param numBlocks  - block amount
 181  * @param headerFile - open file dscriptor
 182  * @param type       - driver or simulator
 183  *
 184  * @return void
 185  */
 186 static void BuildDrmStatics(BlockDef_t * blocks, int numBlocks,
 187                             FILE * headerFile, int type)
 188 {
 189         int i;
 190
 191         TranslationReset();
 192         Translate(headerFile, "drm", "header/topologyHead.h");
 193
 194         /* For each block that's been defined, place a field in the statics
 195            structure.  A PCI device may have a maximum of 6 blocks defined
 196            so ignore any blocks out of the range 0-5. */
 197         for (i = 0; i < numBlocks; i++) {
 198                 TranslationSetFancyNum(blocks[i].blockID);
 199                 Translate(headerFile, "common", "header/blockDef.h");
 200         }
 201
 202         /* Close the statics structure and generate the info one. */
 203         TranslationSetDriverType((type == DRIVER_FT) ? "DRVR" : "SIM");
 204         Translate(headerFile, "common", "header/topologyFoot.h");
 205 }
 206
 207 /**
 208  * @brief Generate the driver's source file.
 209  *
 210  * @param registers    - register description
 211  * @param numRegisters - register amount
 212  * @param blocks       - block description
 213  * @param numBlocks    - block amount
 214  *
 215  * @return void
 216  */
 217 static void BuildDrmDrvrFile(RegisterDef_t * registers, int numRegisters,
 218                              BlockDef_t * blocks, int numBlocks)
 219 {
 220         FILE *dfd = OpenFile(DRIVER_FT, LOC_DRVR, ".c");
 221         int cntr;
 222
 223         TranslationReset();
 224         Translate(dfd, "drm", "driver/head.c");
 225
 226         TranslationSetDriverType("Drvr");
 227         TranslationSetFancyString("DRVR");
 228         TranslationSetDummyString("Driver");
 229         Translate(dfd, "common", "driver/driverHead.c");
 230
 231         /* Generate driver's open routine */
 232         Translate(dfd, "drm", "driver/open/drvrOpen.c");
 233
 234         /* Generate driver's close routine. */
 235         Translate(dfd, "common", "driver/close/head.c");
 236
 237         /* Generate driver's read routine. */
 238         Translate(dfd, "common", "driver/read/head.c");
 239
 240         /* Generate driver's write routine. */
 241         Translate(dfd, "common", "driver/write/head.c");
 242
 243         /* Generate driver's select routine. */
 244         Translate(dfd, "common", "driver/select/head.c");
 245
 246         /* Generate driver's ioctl routine. */
 247         BuildDrvrSimIoctl(registers, numRegisters, dfd);
 248
 249         /* Generate driver's install routine. */
 250         Translate(dfd, "drm", "driver/install/installHead.c");
 251         for (cntr = 0; cntr < numBlocks; cntr++) {
 252                 TranslationSetPlainNum(blocks[cntr].blockID);
 253                 TranslationSetFancyNum(blocks[cntr].blockID);
 254                 Translate(dfd, "drm", "driver/install/installBlock.c");
 255         }
 256         Translate(dfd, "drm", "driver/install/installFoot.c");
 257
 258         /* Generate driver's uninstall routine. */
 259         Translate(dfd, "drm", "driver/uninstall/uninstallHead.c");
 260         for (cntr = 0; cntr < numBlocks; cntr++) {
 261                 TranslationSetPlainNum(blocks[cntr].blockID);
 262                 Translate(dfd, "drm", "driver/uninstall/uninstallBlock.c");
 263         }
 264         Translate(dfd, "drm", "driver/uninstall/uninstallFoot.c");
 265
 266         /* Generate an empty ISR */
 267         Translate(dfd, "common", "driver/isr.c");
 268
 269         /* Build-up dldd structure (driver entry points) */
 270         TranslationSetDriverType("Drvr");
 271         Translate(dfd, "common", "driver/entryPoints.c");
 272
 273         fclose(dfd);
 274 }
 275
 276 /**
 277  * @brief Generate the simulator's source file.
 278  *
 279  * @param registers    - register description
 280  * @param numRegisters - register amount
 281  * @param blocks       - block description
 282  * @param numBlocks    - block amount
 283  *
 284  * @return void
 285  */
 286 static void BuildDrmSimFile(RegisterDef_t * registers, int numRegisters,
 287                             BlockDef_t * blocks, int numBlocks)
 288 {
 289         FILE *sfd = OpenFile(SIM_FT, LOC_DRVR, ".c");
 290         int cntr;
 291
 292         TranslationReset();
 293         Translate(sfd, "drm", "driver/head.c");
 294
 295         TranslationSetDriverType("Sim");
 296         TranslationSetFancyString("SIM");
 297         TranslationSetDummyString("Simulator");
 298         Translate(sfd, "common", "driver/driverHead.c");
 299
 300         /* Generate simulator's open routine. */
 301         Translate(sfd, "drm", "driver/open/simOpenHead.c");
 302         for (cntr = 0; cntr < numBlocks; cntr++) {
 303                 TranslationSetFancyNum(blocks[cntr].blockID);
 304                 TranslationSetPlainNum(blocks[cntr].blockID);
 305                 Translate(sfd, "common", "driver/install/allocateBlock.c");
 306         }
 307         Translate(sfd, "drm", "driver/open/installConfig.c");
 308         Translate(sfd, "drm", "driver/open/simOpenFoot.c");
 309
 310         /* Generate simulator's close routine. */
 311         Translate(sfd, "common", "driver/close/head.c");
 312
 313         /* Generate simulator's read routine. */
 314         Translate(sfd, "common", "driver/read/head.c");
 315
 316         /* Generate simulator's write routine. */
 317         Translate(sfd, "common", "driver/write/head.c");
 318
 319         /* Generate simulator's select routine. */
 320         Translate(sfd, "common", "driver/select/head.c");
 321
 322         /* Generate simulator's ioctl routine. */
 323         BuildDrvrSimIoctl(registers, numRegisters, sfd);
 324
 325         /* Generate simulator's install routine. */
 326         Translate(sfd, "drm", "driver/install/simInstall.c");
 327
 328         /* Generate simulator's uninstall routine. */
 329         Translate(sfd, "drm", "driver/uninstall/simUninstallHead.c");
 330         for (cntr = 0; cntr < numBlocks; cntr++) {
 331                 TranslationSetFancyNum(blocks[cntr].blockID);
 332                 TranslationSetPlainNum(blocks[cntr].blockID);
 333                 Translate(sfd, "common", "driver/uninstall/uninstallBlocks.c");
 334         }
 335         Translate(sfd, "common", "driver/uninstall/foot.c");
 336
 337         /* Generate an empty ISR */
 338         Translate(sfd, "common", "driver/isr.c");
 339
 340         /* Build-up dldd structure (simulator entry points) */
 341         TranslationSetDriverType("Sim");
 342         Translate(sfd, "common", "driver/entryPoints.c");
 343
 344         fclose(sfd);
 345 }