Changeset 2811

Show
Ignore:
Timestamp:
06/01/21 17:11:47 (3 years ago)
Author:
jwoithe
Message:

Cosmetic: "firewire" should be "FireWire?" when used as the bus name.

Similarly to r2802 and r2810, "FireWire?" should be used when referring to
the name of the bus. This patch corrects this throughout the source tree
for completeness. While there are a small number of mostly debug output
strings affected, most of the changes are to comments or developer documents
where they are of little consequence. Thanks to Pander who suggested the
need to look into this on the ffado-devel mailing list.

At least in theory, remaining instances of "firewire" in the source tree
should remain as they are because they refer to case-sensitive identifiers
defined externally (such as the "firewire" jackd backend name).

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved
  • trunk/libffado/doc/motu_firewire_protocol.txt

    r1898 r2811  
    1 Notes on the firewire protocol used by MOTU audio devices 
     1Notes on the FireWire protocol used by MOTU audio devices 
    22========================================================= 
    33 
     
    1515 
    1616Audio data is sent via iso packets.  With nothing else present on the 
    17 firewire bus Iso channel 0 is used by the PC to send data to the MOTU while 
     17FireWire bus Iso channel 0 is used by the PC to send data to the MOTU while 
    1818iso channel 1 is used by the MOTU to send data to the PC.  The channels 
    1919used can be arbitarily chosen by software subject to availability as 
     
    73731x rates and 840 at 2x rates. 
    7474 
    75 The Traveler usually becomes the IRM on the firewire bus it is plugged into; 
     75The Traveler usually becomes the IRM on the FireWire bus it is plugged into; 
    7676when functioning as the IRM it also broadcasts "cycle start" packets on a 
    7777regular basis as would be expected. These appear to be as per ieee1394-1995.  
     
    725725specify the iso channel the Motu should send its data on (ie: the Motu->PC 
    726726iso channel number).  This makes sense since there are 64 iso channels 
    727 available on the firewire bus requiring 6 bits to specify.  If it is then 
     727available on the FireWire bus requiring 6 bits to specify.  If it is then 
    728728assumed that bits 15-0 are reserved we have the following layout for 
    729729this register. 
  • trunk/libffado/doc/rme_notes/rme_config_register_map.txt

    r2802 r2811  
    247247 
    248248Status register 2: 
    249   bits 31-0: (FF800 only) firewire iso channel used for data from FF800 to PC 
     249  bits 31-0: (FF800 only) FireWire iso channel used for data from FF800 to PC 
    250250 
    251251Status register 3: 
     
    687687The third quadlet is mapped as follows. 
    688688  bits 10-0 = number of audio channels 
    689   bit 11    = speed flag; set to 1 if firewire bus is at 800 Mbps 
     689  bit 11    = speed flag; set to 1 if FireWire bus is at 800 Mbps 
    690690In local tests with a FF800 the value of this register was always 0x0000001c 
    691 (28 channels, 400 Mbps firewire bus). 
     691(28 channels, 400 Mbps FireWire bus). 
    692692 
    693693The forth and fifth quadlets (used only by the FF400) are zero. 
     
    702702as follows: 
    703703  bits 10-0 = number of audio channels 
    704   bit 11    = bus speed flag; set to 1 if firewire bus is at 800 Mbps 
     704  bit 11    = bus speed flag; set to 1 if FireWire bus is at 800 Mbps 
    705705On a FF400 the register is as follows: 
    706706  bits 4-0  = number of audio channels 
     
    741741 
    742742No CIP header is included in the iso data packet.  Fireface data follows 
    743 immediately after the standard 2-quadlet firewire iso packet header. 
     743immediately after the standard 2-quadlet FireWire iso packet header. 
    744744 
    745745Each iso packet contains a number of samples across all 28 device channels 
  • trunk/libffado/libffado/ffado.h.in

    r2803 r2811  
    149149 * The actual meaning of the device specification should be one of the following: 
    150150 * - Format 1: "hw:x[,y[,z]]" 
    151  *     x = the firewire bus to use ('port' in raw1394 terminology) 
     151 *     x = the FireWire bus to use ('port' in raw1394 terminology) 
    152152 *         (mandatory) 
    153153 *     y = the node id the device currently has (bus resets might change that, but FFADO  
  • trunk/libffado/README

    r2810 r2811  
    190190NOTE: In order to build jackd with ffado support, you have  
    191191to install libffado before you build jackd. The backend to use in jackd is 
    192 firewire
     192"firewire"
    193193 
    194194NOTE: the beta versions are distributed with debugging enabled by default. 
  • trunk/libffado/src/devicemanager.cpp

    r2803 r2811  
    185185    } 
    186186    if (nb_detected_ports == 0) { 
    187         debugFatal("No firewire adapters (ports) found.\n"); 
     187        debugFatal("No FireWire adapters (ports) found.\n"); 
    188188        return false; 
    189189    } 
    190     debugOutput( DEBUG_LEVEL_VERBOSE, "Found %d firewire adapters (ports)\n", nb_detected_ports); 
     190    debugOutput( DEBUG_LEVEL_VERBOSE, "Found %d FireWire adapters (ports)\n", nb_detected_ports); 
    191191    for (unsigned int port = 0; port < (unsigned int)nb_detected_ports; port++) { 
    192192        Ieee1394Service* tmp1394Service = new Ieee1394Service(); 
  • trunk/libffado/src/digidesign/digidesign_avdevice.cpp

    r2803 r2811  
    279279    // will ultimately show up as JACK ports - one per audio channel. 
    280280 
    281     // Store the number of frames per firewire packet.  Depending on the 
     281    // Store the number of frames per FireWire packet.  Depending on the 
    282282    // device protocol this may not need to be stored in a data field of  
    283283    // the object, in which case frames_per_packet could be come a local 
     
    438438signed int 
    439439Device::getFramesPerPacket(void) { 
    440     // Return the number of frames transmitted in a single firewire packet. 
     440    // Return the number of frames transmitted in a single FireWire packet. 
    441441    // For some devices this is fixed, while for others it depends on the 
    442442    // current sampling rate. 
  • trunk/libffado/src/libieee1394/ieee1394service.cpp

    r2803 r2811  
    183183This usually means:\n\ 
    184184 a) The device-node /dev/raw1394 doesn't exists because you don't have a\n\ 
    185     (recognized) firewire controller.\n \ 
     185    (recognized) FireWire controller.\n \ 
    186186 b) The modules needed aren't loaded. This is not in the scope of ffado but of\n\ 
    187     your distribution, so if you have a firewire controller that should be\n\ 
     187    your distribution, so if you have a FireWire controller that should be\n\ 
    188188    supported and the modules aren't loaded, file a bug with your distributions\n\ 
    189189    bug tracker.\n \ 
  • trunk/libffado/src/libieee1394/ieee1394service.h

    r2803 r2811  
    6868 
    6969   /** 
    70     * @brief get number of ports (firewire adapters) in this machine 
     70    * @brief get number of ports (FireWire adapters) in this machine 
    7171    * 
    7272    * @return the number of ports 
  • trunk/libffado/src/libieee1394/IsoHandlerManager.cpp

    r2803 r2811  
    146146        // FIXME: This is a very crude guard against some other thread 
    147147        // deleting handlers while this function is running.  While this 
    148         // didn't tend to happen with the old kernel firewire stack, delays 
     148        // didn't tend to happen with the old kernel FireWire stack, delays 
    149149        // in shutdown experienced in the new stack mean it can happen that 
    150150        // a handler disappears during the running of this function.  This 
     
    13361336// have called disable() on the handler (in the FW_ISORCV/FW_ISOXMT 
    13371337// threads).  However, the raw1394_destroy_handle() call therein takes 
    1338 // upwards of 20 milliseconds to complete under the new kernel firewire 
     1338// upwards of 20 milliseconds to complete under the new kernel FireWire 
    13391339// stack, and may not have completed by the time ~IsoHandler() is called by 
    13401340// the "jackd" thread.  Thus, wait for the lock before testing the state 
     
    18801880    if (i == EBUSY) { 
    18811881        // Some other thread is disabling this handler, a process which can 
    1882         // take considerable time when using the new kernel firewire stack.  
     1882        // take considerable time when using the new kernel FireWire stack.  
    18831883        // Wait until it is finished before returning so the present caller 
    18841884        // can act knowing that the disable has occurred and is complete 
     
    19231923    raw1394_iso_shutdown(m_handle); 
    19241924 
    1925     // When running on the new kernel firewire stack, this call can take of 
     1925    // When running on the new kernel FireWire stack, this call can take of 
    19261926    // the order of 20 milliseconds to return, in which time other threads 
    19271927    // may wish to test the state of the handler and call this function 
  • trunk/libffado/src/libstreaming/amdtp/AmdtpReceiveStreamProcessor.cpp

    r2803 r2811  
    155155    but the actual packet does contain a reduced set of channels. 
    156156 
    157     The channels are referred to as Dimensions in the firewire parlance. 
     157    The channels are referred to as Dimensions in the FireWire parlance. 
    158158    With an Audiofire Pre8, we typically receive 17 channels of data at 
    159159    44100 and 48000, being 8 Analog, 8 Digital and 1 MIDI. When we switch 
  • trunk/libffado/src/libstreaming/digidesign/DigidesignReceiveStreamProcessor.cpp

    r2803 r2811  
    6969unsigned int 
    7070DigidesignReceiveStreamProcessor::getNominalFramesPerPacket() { 
    71     // Return the number of frames per firewire iso packet.  A "frame" here is a collection 
     71    // Return the number of frames per FireWire iso packet.  A "frame" here is a collection 
    7272    // of a single audio sample from all active audio channels.  If this depends on the 
    7373    // sample rate, that can be obtained using something like this: 
     
    9797    // extract a timestamp from it.  "data" points to the iso packet's 
    9898    // contents - no assumption is made about what constitutes a "header" 
    99     // because each device's protocol is different.  Note that the firewire 
     99    // because each device's protocol is different.  Note that the FireWire 
    100100    // ISO header is not included in "data". 
    101101    // 
     
    109109    // 
    110110    // Other parameters to this function contain selected information from 
    111     // the firewire ISO header which came with this packet: 
     111    // the FireWire ISO header which came with this packet: 
    112112    //   - length = length in bytes of the content pointed to by "data". 
    113113    //   - tag = the iso packet header's "tag" field. 
  • trunk/libffado/src/libstreaming/digidesign/DigidesignTransmitStreamProcessor.cpp

    r2803 r2811  
    111111    // overriden in generateEmptyPacketHeader(). 
    112112    // 
    113     // As per the firewire standards, only set "tag" if the Digidesign 
     113    // As per the FireWire standards, only set "tag" if the Digidesign 
    114114    // expects a CIP header in the first two bytes of "data".  Similarly, 
    115115    // remove the "+8" from the length calculation if no CIP header is to be 
  • trunk/libffado/src/rme/fireface_flash.cpp

    r2803 r2811  
    300300    // unsigned, so there's no need to check for values less than 0. 
    301301    if (hw_settings.limit_bandwidth > FF_DEV_FLASH_BWLIMIT_ANALOG_ONLY) { 
    302         debugOutput(DEBUG_LEVEL_WARNING, "bogus firewire bandwidth limit flag 0x%08x reset to 0 (send all channels)\n", 
     302        debugOutput(DEBUG_LEVEL_WARNING, "bogus FireWire bandwidth limit flag 0x%08x reset to 0 (send all channels)\n", 
    303303          hw_settings.limit_bandwidth); 
    304304        hw_settings.limit_bandwidth = FF_DEV_FLASH_BWLIMIT_SEND_ALL_CHANNELS; 
     
    392392        debugOutput(DEBUG_LEVEL_VERBOSE, "  sync ref: %d\n", dsettings->sync_ref); 
    393393        debugOutput(DEBUG_LEVEL_VERBOSE, "  tms: %d\n", dsettings->tms); 
    394         debugOutput(DEBUG_LEVEL_VERBOSE, "  limit firewire bandwidth: %d\n", dsettings->limit_bandwidth); 
     394        debugOutput(DEBUG_LEVEL_VERBOSE, "  limit FireWire bandwidth: %d\n", dsettings->limit_bandwidth); 
    395395        debugOutput(DEBUG_LEVEL_VERBOSE, "  stop on dropout: %d\n", dsettings->stop_on_dropout); 
    396396        debugOutput(DEBUG_LEVEL_VERBOSE, "  input level: %d\n", dsettings->input_level); 
  • trunk/libffado/support/firmware/bridgeco-downloader.cpp

    r2803 r2811  
    160160        } else { 
    161161            cout << "Firmware download was successful" << endl; 
    162             cout << "Please reboot the device by removing the power and firewire connections." << endl; 
     162            cout << "Please reboot the device by removing the power and FireWire connections." << endl; 
    163163        } 
    164164    } else if ( strcmp( args->args[1], "cne" ) == 0 ) { 
     
    174174        } else { 
    175175            cout << "CnE download was successful" << endl; 
    176             cout << "Please reboot the device by removing the power and firewire connections." << endl; 
     176            cout << "Please reboot the device by removing the power and FireWire connections." << endl; 
    177177        } 
    178178    } else if ( strcmp( args->args[1], "display" ) == 0 ) { 
  • trunk/libffado/support/firmware/ffado-fireworks-downloader.1

    r2089 r2811  
    1717.TP 
    1818.B list 
    19 List devices on the firewire bus. 
     19List devices on the FireWire bus. 
    2020.TP 
    2121.B display 
  • trunk/libffado/support/tools/ffado-diag.1

    r2751 r2811  
    1010prints out an extensive collection of diagnostic information about the 
    1111computer it is run on.  Information included is the FFADO version number, 
    12 the version number of libraries which FFADO depends on, the firewire 
     12the version number of libraries which FFADO depends on, the FireWire 
    1313interface card, interrupt usage, and so on.  This is useful for developers 
    1414to know when giving support via the FFADO mailing lists.  For anything other 
  • trunk/libffado/tests/scan-devreg.cpp

    r2803 r2811  
    210210      p2++; 
    211211    } 
    212     printf("Scanning %d firewire adapters (ports)\n", n_ports); 
     212    printf("Scanning %d FireWire adapters (ports)\n", n_ports); 
    213213    for (signed int i=p1; i<p2; i++) { 
    214214        Ieee1394Service *tmp1394 = new Ieee1394Service(); 
     
    250250    } 
    251251    if (node_id == -1) { 
    252         printf("Could not find a target audio device on the firewire bus\n"); 
     252        printf("Could not find a target audio device on the FireWire bus\n"); 
    253253        return false; 
    254254    } 
  • trunk/libffado/tests/systemtests/test-isorecv-1.cpp

    r2803 r2811  
    6767static struct argp_option options[] = { 
    6868    {"verbose",  'v', "level",    0,  "Verbose level" }, 
    69     {"port",  'p', "port",  0,  "firewire port to use" }, 
     69    {"port",  'p', "port",  0,  "FireWire port to use" }, 
    7070    {"channel",  'c', "channel",  0,  "iso channel to use" }, 
    7171    {"packetsize",  's', "packetsize",  0,  "packet size to use" }, 
  • trunk/libffado/tests/systemtests/test-isoxmit-1.cpp

    r2803 r2811  
    8484static struct argp_option options[] = { 
    8585    {"verbose",  'v', "level",    0,  "Verbose level" }, 
    86     {"port",  'p', "port",  0,  "firewire port to use" }, 
     86    {"port",  'p', "port",  0,  "FireWire port to use" }, 
    8787    {"channel",  'c', "channel",  0,  "iso channel to use" }, 
    8888    {"packetsize",  's', "packetsize",  0,  "packet size to use" }, 
  • trunk/libffado/tests/test-ieee1394service.cpp

    r2803 r2811  
    307307                printf( "USAGE:\n\ 
    308308 Currently two options are understood:\n\ 
    309   --port <number> or -p <number> selects the firewire-port to use, default is 0\n\ 
     309  --port <number> or -p <number> selects the FireWire-port to use, default is 0\n\ 
    310310  --verbose <number> or -v <number> selects the verbose level, default is 4\n\ 
    311311  --help or -h shows this help and exits.\n\