workbench/devs/AHI/Drivers/Common/library.c

   1
   2 /*
   3  *  Shared library code
   4  */
   5
   6 #include <config.h>
   7
   8 #include <exec/alerts.h>
   9 #include <exec/libraries.h>
  10 #include <exec/resident.h>
  11 #include <utility/utility.h>
  12
  13 #include <clib/alib_protos.h>
  14 #include <proto/ahi_sub.h>
  15 #include <proto/exec.h>
  16 #include <proto/intuition.h>
  17 #include <proto/utility.h>
  18
  19 #define DRIVER_LIBSTUB
  20
  21 #include "gatestubs.h"
  22 #include "library.h"
  23
  24 #include "DriverData.h"
  25 #include "version.h"
  26
  27 #ifndef INTUITIONNAME
  28 #define INTUITIONNAME "intuition.library"
  29 #endif
  30
  31 #ifdef __amithlon__
  32 # define RTF_NATIVE (1<<3)
  33 # define FUNCARRAY_32BIT_NATIVE 0xfffefffe
  34 #endif
  35
  36 #if !defined( __AROS__ ) && !defined( __amithlon__ )
  37 extern void _etext;
  38 #else
  39 # define _etext RomTag+1 // Fake it
  40 #endif
  41
  42 /******************************************************************************
  43 ** Function prototypes ********************************************************
  44 ******************************************************************************/
  45
  46 struct DriverBase*
  47 _LibInit( struct DriverBase* AHIsubBase,
  48           BPTR               seglist,
  49           struct ExecBase*   sysbase );
  50
  51 BPTR
  52 _LibExpunge( struct DriverBase* AHIsubBase );
  53
  54 struct DriverBase*
  55 _LibOpen( ULONG              version,
  56           struct DriverBase* AHIsubBase );
  57
  58 BPTR
  59 _LibClose( struct DriverBase* AHIsubBase );
  60
  61 ULONG
  62 _LibNull( struct DriverBase* AHIsubBase );
  63
  64
  65 /******************************************************************************
  66 ** Driver entry ***************************************************************
  67 ******************************************************************************/
  68
  69 #if defined( __amithlon__ )
  70 __asm( "\n\
  71          .text;\n\
  72          .byte 0x4e, 0xfa, 0x00, 0x03\n\
  73          jmp _start" );
  74 #endif
  75
  76 int
  77 _start( void )
  78 {
  79   return -1;
  80 }
  81
  82 #if defined( __MORPHOS__ )
  83 ULONG   __abox__=1;
  84 ULONG   __amigappc__=1;  // deprecated, used in MOS 0.4
  85 #endif
  86
  87 /******************************************************************************
  88 ** Driver resident structure **************************************************
  89 ******************************************************************************/
  90
  91 #if defined( __AMIGAOS4__  )
  92 static const struct TagItem InitTable[];
  93 #else
  94 static const APTR InitTable[4];
  95 #endif
  96
  97 // This structure must reside in the text segment or the read-only
  98 // data segment!  "const" makes it happen.
  99 const struct Resident RomTag __attribute__((used)) =
 100 {
 101   RTC_MATCHWORD,
 102   (struct Resident *) &RomTag,
 103   (struct Resident *) &_etext,
 104 #if defined( __MORPHOS__ )
 105   RTF_EXTENDED | RTF_PPC | RTF_AUTOINIT,
 106 #elif defined( __AROS__ )
 107   RTF_EXTENDED | RTF_AUTOINIT,
 108 #elif defined( __amithlon__ )
 109   RTF_NATIVE | RTF_AUTOINIT,
 110 #elif defined( __AMIGAOS4__ )
 111   RTF_NATIVE | RTF_AUTOINIT,
 112 #else
 113   RTF_AUTOINIT,
 114 #endif
 115   VERSION,
 116   NT_LIBRARY,
 117   0,                      /* priority */
 118   (BYTE *) LibName,
 119   (BYTE *) LibIDString,
 120   (APTR) &InitTable
 121 #if defined( __MORPHOS__ ) || defined( __AROS__ )
 122   , REVISION, NULL
 123 #endif
 124 };
 125
 126
 127 /******************************************************************************
 128 ** Globals ********************************************************************
 129 ******************************************************************************/
 130
 131 const char  LibName[]     = DRIVER;
 132 const char  LibIDString[] = DRIVER " " VERS "\r\n";
 133 const UWORD LibVersion    = VERSION;
 134 const UWORD LibRevision   = REVISION;
 135
 136
 137 /******************************************************************************
 138 ** Library stuff **************************************************************
 139 ******************************************************************************/
 140
 141 #ifndef __AMIGAOS4__
 142
 143 static const APTR FuncTable[] =
 144 {
 145 #if defined( __MORPHOS__ ) || defined( __amithlon__ )
 146   (APTR) FUNCARRAY_32BIT_NATIVE,
 147 #endif
 148
 149   gwLibOpen,
 150   gwLibClose,
 151   gwLibExpunge,
 152   gwLibNull,
 153
 154   gwAHIsub_AllocAudio,
 155   gwAHIsub_FreeAudio,
 156   gwAHIsub_Disable,
 157   gwAHIsub_Enable,
 158   gwAHIsub_Start,
 159   gwAHIsub_Update,
 160   gwAHIsub_Stop,
 161   gwAHIsub_SetVol,
 162   gwAHIsub_SetFreq,
 163   gwAHIsub_SetSound,
 164   gwAHIsub_SetEffect,
 165   gwAHIsub_LoadSound,
 166   gwAHIsub_UnloadSound,
 167   gwAHIsub_GetAttr,
 168   gwAHIsub_HardwareControl,
 169
 170   (APTR) -1
 171 };
 172
 173
 174 static const APTR InitTable[4] =
 175 {
 176   (APTR) DRIVERBASE_SIZEOF,
 177   (APTR) &FuncTable,
 178   NULL,
 179 #if defined( __MORPHOS__ ) || defined( __amithlon__ )
 180   (APTR) _LibInit
 181 #else
 182   (APTR) gwLibInit
 183 #endif
 184 };
 185
 186 #else // __AMIGAOS4__
 187
 188 static ULONG generic_Obtain(struct Interface *Self)
 189 {
 190   return Self->Data.RefCount++;
 191 }
 192
 193
 194 static ULONG generic_Release(struct Interface *Self)
 195 {
 196   return Self->Data.RefCount--;
 197 }
 198
 199
 200 static const CONST_APTR LibManagerVectors[] =
 201 {
 202   generic_Obtain,
 203   generic_Release,
 204   NULL,
 205   NULL,
 206
 207   gwLibOpen,
 208   gwLibClose,
 209   gwLibExpunge,
 210   NULL,
 211
 212   (CONST_APTR) -1,
 213 };
 214
 215 static const struct TagItem LibManagerTags[] =
 216 {
 217   { MIT_Name,             (ULONG) "__library"       },
 218   { MIT_VectorTable,      (ULONG) LibManagerVectors },
 219   { MIT_Version,          1                         },
 220   { TAG_DONE,             0                         }
 221 };
 222
 223
 224 static const CONST_APTR MainVectors[] = {
 225   generic_Obtain,
 226   generic_Release,
 227   NULL,
 228   NULL,
 229
 230   gwAHIsub_AllocAudio,
 231   gwAHIsub_FreeAudio,
 232   gwAHIsub_Disable,
 233   gwAHIsub_Enable,
 234   gwAHIsub_Start,
 235   gwAHIsub_Update,
 236   gwAHIsub_Stop,
 237   gwAHIsub_SetVol,
 238   gwAHIsub_SetFreq,
 239   gwAHIsub_SetSound,
 240   gwAHIsub_SetEffect,
 241   gwAHIsub_LoadSound,
 242   gwAHIsub_UnloadSound,
 243   gwAHIsub_GetAttr,
 244   gwAHIsub_HardwareControl,
 245
 246   (CONST_APTR) -1
 247 };
 248
 249 static const struct TagItem MainTags[] =
 250 {
 251   { MIT_Name,              (ULONG) "main"      },
 252   { MIT_VectorTable,       (ULONG) MainVectors },
 253   { MIT_Version,           1                   },
 254   { TAG_DONE,              0                   }
 255 };
 256
 257
 258 /* MLT_INTERFACES array */
 259 static const CONST_APTR Interfaces[] =
 260 {
 261   LibManagerTags,
 262   MainTags,
 263   NULL
 264 };
 265
 266 /* m68k library vectors */
 267 static const CONST_APTR VecTable68K[] = {
 268   (CONST_APTR) &m68kgwLibOpen,
 269   (CONST_APTR) &m68kgwLibClose,
 270   (CONST_APTR) &m68kgwLibExpunge,
 271   (CONST_APTR) &m68kgwLibNull,
 272
 273   (CONST_APTR) &m68kgwAHIsub_AllocAudio,
 274   (CONST_APTR) &m68kgwAHIsub_FreeAudio,
 275   (CONST_APTR) &m68kgwAHIsub_Disable,
 276   (CONST_APTR) &m68kgwAHIsub_Enable,
 277   (CONST_APTR) &m68kgwAHIsub_Start,
 278   (CONST_APTR) &m68kgwAHIsub_Update,
 279   (CONST_APTR) &m68kgwAHIsub_Stop,
 280   (CONST_APTR) &m68kgwAHIsub_SetVol,
 281   (CONST_APTR) &m68kgwAHIsub_SetFreq,
 282   (CONST_APTR) &m68kgwAHIsub_SetSound,
 283   (CONST_APTR) &m68kgwAHIsub_SetEffect,
 284   (CONST_APTR) &m68kgwAHIsub_LoadSound,
 285   (CONST_APTR) &m68kgwAHIsub_UnloadSound,
 286   (CONST_APTR) &m68kgwAHIsub_GetAttr,
 287   (CONST_APTR) &m68kgwAHIsub_HardwareControl,
 288
 289   (CONST_APTR) -1
 290 };
 291
 292 /* CreateLibrary() tag list */
 293 static const struct TagItem InitTable[] =
 294 {
 295   { CLT_DataSize,         DRIVERBASE_SIZEOF   },
 296   { CLT_Interfaces,       (ULONG) Interfaces  },
 297   { CLT_Vector68K,        (ULONG) VecTable68K },
 298   { CLT_InitFunc,         (ULONG) gwLibInit   },
 299   { TAG_DONE,             0                   }
 300 };
 301
 302 #endif // __AMIGAOS4__
 303
 304
 305 /******************************************************************************
 306 ** Message requester **********************************************************
 307 ******************************************************************************/
 308
 309 void
 310 ReqA( const char*        text,
 311       APTR               args,
 312       struct DriverBase* AHIsubBase )
 313 {
 314   struct IntuitionBase *IntuitionBase = AHIsubBase->intuitionbase;
 315   struct EasyStruct es =
 316   {
 317     sizeof (struct EasyStruct),
 318     0,
 319     (STRPTR) LibName,
 320     (STRPTR) text,
 321     "OK"
 322 #ifdef __AMIGAOS4__
 323     , NULL, NULL
 324 #endif
 325   };
 326
 327   EasyRequestArgs( NULL, &es, NULL, args );
 328 }
 329
 330 /******************************************************************************
 331 ** Serial port debugging ******************************************************
 332 ******************************************************************************/
 333
 334 #ifndef __AMIGAOS4__
 335
 336 #if defined( __AROS__ ) && !defined( __mc68000__ )
 337
 338 #include <aros/asmcall.h>
 339
 340 AROS_UFH2( void,
 341            rawputchar_m68k,
 342            AROS_UFHA( UBYTE,            c,       D0 ),
 343            AROS_UFHA( struct ExecBase*, sysbase, A3 ) )
 344 {
 345   AROS_USERFUNC_INIT
 346
 347   AROS_LC1NR(void, RawPutChar, AROS_LCA(UBYTE, c, D0), struct ExecBase *, sysbase, 86, Exec);
 348
 349   AROS_USERFUNC_EXIT
 350 }
 351
 352 #else
 353
 354 static const UWORD rawputchar_m68k[] =
 355 {
 356   0x2C4B,             // MOVEA.L A3,A6
 357   0x4EAE, 0xFDFC,     // JSR     -$0204(A6)
 358   0x4E75              // RTS
 359 };
 360
 361 #endif
 362
 363 void
 364 MyKPrintFArgs( UBYTE*           fmt,
 365                ULONG*           args,
 366                struct DriverBase* AHIsubBase )
 367 {
 368   RawDoFmt( fmt, args, (void(*)(void)) rawputchar_m68k, SysBase );
 369 }
 370
 371 #endif
 372
 373 /******************************************************************************
 374 ** HookEntry ******************************************************************
 375 ******************************************************************************/
 376
 377 #if defined( __MORPHOS__ )
 378
 379 /* Should be in libamiga, but isn't? */
 380
 381 static ULONG
 382 gw_HookEntry( void )
 383 {
 384   struct Hook* h   = (struct Hook*) REG_A0;
 385   void*        o   = (void*)        REG_A2;
 386   void*        msg = (void*)        REG_A1;
 387
 388   return ( ( (ULONG(*)(struct Hook*, void*, void*)) *h->h_SubEntry)( h, o, msg ) );
 389 }
 390
 391 struct EmulLibEntry _HookEntry =
 392 {
 393   TRAP_LIB, 0, (void (*)(void)) &gw_HookEntry
 394 };
 395
 396 __asm( ".globl HookEntry;HookEntry=_HookEntry" );
 397
 398 #endif
 399
 400 /******************************************************************************
 401 ** Library init ***************************************************************
 402 ******************************************************************************/
 403
 404 #ifdef __AROS__
 405 #include <aros/symbolsets.h>
 406
 407 THIS_PROGRAM_HANDLES_SYMBOLSET(INIT)
 408 THIS_PROGRAM_HANDLES_SYMBOLSET(EXIT)
 409 DEFINESET(INIT)
 410 DEFINESET(EXIT)
 411 #endif
 412
 413 struct DriverBase*
 414 _LibInit( struct DriverBase* AHIsubBase,
 415           BPTR               seglist,
 416           struct ExecBase*   sysbase )
 417 {
 418   SysBase = sysbase;
 419
 420 #ifdef __AROS__
 421   if (!set_call_funcs(SETNAME(INIT), 1, 1))
 422       return NULL;
 423 #endif
 424
 425 #ifdef __AMIGAOS4__
 426   IExec = (struct ExecIFace*) SysBase->MainInterface;
 427 #endif
 428
 429   AHIsubBase->library.lib_Node.ln_Type = NT_LIBRARY;
 430   AHIsubBase->library.lib_Node.ln_Name = (STRPTR) LibName;
 431   AHIsubBase->library.lib_Flags        = LIBF_SUMUSED | LIBF_CHANGED;
 432   AHIsubBase->library.lib_Version      = VERSION;
 433   AHIsubBase->library.lib_Revision     = REVISION;
 434   AHIsubBase->library.lib_IdString     = (STRPTR) LibIDString;
 435   AHIsubBase->seglist                  = seglist;
 436
 437   AHIsubBase->intuitionbase = (struct IntuitionBase *)OpenLibrary( INTUITIONNAME, 37 );
 438   AHIsubBase->utilitybase   = (struct UtilityBase *)OpenLibrary( UTILITYNAME, 37 );
 439
 440   if( AHIsubBase->intuitionbase == NULL )
 441   {
 442     Alert( AN_Unknown|AG_OpenLib|AO_Intuition );
 443     goto error;
 444   }
 445
 446 #ifdef __AMIGAOS4__
 447   if ((IIntuition = (struct IntuitionIFace *) GetInterface((struct Library*) AHIsubBase->intuitionbase, "main", 1, NULL)) == NULL)
 448   {
 449     Alert( AN_Unknown|AG_OpenLib|AO_Intuition );
 450     goto error;
 451   }
 452 #endif
 453
 454   if( AHIsubBase->utilitybase == NULL )
 455   {
 456     Req( "Unable to open 'utility.library' version 37.\n" );
 457     goto error;
 458   }
 459
 460 #ifdef __AMIGAOS4__
 461   if ((IUtility = (struct UtilityIFace *) GetInterface((struct Library*) AHIsubBase->utilitybase, "main", 1, NULL)) == NULL)
 462   {
 463     Req("Couldn't open IUtility interface!\n");
 464     goto error;
 465   }
 466
 467   if ((IAHIsub = (struct AHIsubIFace *) GetInterface((struct Library *) AHIsubBase, "main", 1, NULL)) == NULL)
 468   {
 469     Req("Couldn't open IAHIsub interface!\n");
 470     return FALSE;
 471   }
 472 #endif
 473
 474   if( ! DriverInit( AHIsubBase ) )
 475   {
 476     goto error;
 477   }
 478
 479   return AHIsubBase;
 480
 481 error:
 482   _LibExpunge( AHIsubBase );
 483   return NULL;
 484 }
 485
 486
 487 /******************************************************************************
 488 ** Library clean-up ***********************************************************
 489 ******************************************************************************/
 490
 491 #ifndef __AMIGAOS4__
 492 # define DeleteLibrary(base) FreeMem((APTR)(((char*) base) - \
 493                                             ((struct Library*) base)->lib_NegSize), \
 494                                      ((struct Library*) base)->lib_NegSize + \
 495                                      ((struct Library*) base)->lib_PosSize)
 496 #endif
 497
 498 BPTR
 499 _LibExpunge( struct DriverBase* AHIsubBase )
 500 {
 501   BPTR seglist = 0;
 502
 503   if( AHIsubBase->library.lib_OpenCnt == 0 )
 504   {
 505     seglist = AHIsubBase->seglist;
 506
 507     /* Since LibInit() calls us on failure, we have to check if we're
 508        really added to the library list before removing us. */
 509
 510     if( AHIsubBase->library.lib_Node.ln_Succ != NULL )
 511     {
 512       Remove( (struct Node *) AHIsubBase );
 513     }
 514
 515     DriverCleanup( AHIsubBase );
 516
 517 #ifdef __AMIGAOS4__
 518     DropInterface((struct Interface *) IAHIsub);
 519     DropInterface((struct Interface *) IIntuition);
 520     DropInterface((struct Interface *) IUtility);
 521 #endif
 522
 523     /* Close libraries */
 524     CloseLibrary(&AHIsubBase->intuitionbase->LibNode );
 525     CloseLibrary(&AHIsubBase->utilitybase->ub_LibNode );
 526
 527 #ifdef __AROS__
 528     set_call_funcs(SETNAME(EXIT), -1, 0);
 529 #endif
 530
 531     DeleteLibrary(&AHIsubBase->library);
 532   }
 533   else
 534   {
 535     AHIsubBase->library.lib_Flags |= LIBF_DELEXP;
 536   }
 537
 538   return seglist;
 539 }
 540
 541
 542 /******************************************************************************
 543 ** Library opening ************************************************************
 544 ******************************************************************************/
 545
 546 struct DriverBase*
 547 _LibOpen( ULONG              version,
 548           struct DriverBase* AHIsubBase )
 549 {
 550   AHIsubBase->library.lib_Flags &= ~LIBF_DELEXP;
 551   AHIsubBase->library.lib_OpenCnt++;
 552
 553   return AHIsubBase;
 554 }
 555
 556
 557 /******************************************************************************
 558 ** Library closing ************************************************************
 559 ******************************************************************************/
 560
 561 BPTR
 562 _LibClose( struct DriverBase* AHIsubBase )
 563 {
 564   BPTR seglist = 0;
 565
 566   AHIsubBase->library.lib_OpenCnt--;
 567
 568   if( AHIsubBase->library.lib_OpenCnt == 0 )
 569   {
 570     if( AHIsubBase->library.lib_Flags & LIBF_DELEXP )
 571     {
 572       seglist = _LibExpunge( AHIsubBase );
 573     }
 574   }
 575
 576   return seglist;
 577 }
 578
 579
 580 /******************************************************************************
 581 ** Unused function ************************************************************
 582 ******************************************************************************/
 583
 584 ULONG
 585 _LibNull( struct DriverBase* AHIsubBase )
 586 {
 587   return 0;
 588 }