root/trunk/libffado/src/dice/dice_eap.h

Revision 1779, 18.5 kB (checked in by arnonym, 11 years ago)

Rewrite the RouterConfig? and save lots of code.

Plus, it seems I fixed a "bug" where the device would output a high pitched sound when an output was disconnected. Now this seems gone...

Next stop: PeakSpace?

Line 
1 /*
2  * Copyright (C) 2005-2009 by Pieter Palmers
3  *
4  * This file is part of FFADO
5  * FFADO = Free Firewire (pro-)audio drivers for linux
6  *
7  * FFADO is based upon FreeBoB
8  *
9  * This program is free software: you can redistribute it and/or modify
10  * it under the terms of the GNU General Public License as published by
11  * the Free Software Foundation, either version 2 of the License, or
12  * (at your option) version 3 of the License.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
21  *
22  */
23 #ifndef __DICE_EAP_H
24 #define __DICE_EAP_H
25
26 #include "dice_avdevice.h"
27
28 #define DICE_EAP_BASE                  0x0000000000200000ULL
29 #define DICE_EAP_MAX_SIZE              0x0000000000F00000ULL
30
31 #define DICE_EAP_CAPABILITY_SPACE_OFF      0x0000
32 #define DICE_EAP_CAPABILITY_SPACE_SZ       0x0004
33 #define DICE_EAP_CMD_SPACE_OFF             0x0008
34 #define DICE_EAP_CMD_SPACE_SZ              0x000C
35 #define DICE_EAP_MIXER_SPACE_OFF           0x0010
36 #define DICE_EAP_MIXER_SPACE_SZ            0x0014
37 #define DICE_EAP_PEAK_SPACE_OFF            0x0018
38 #define DICE_EAP_PEAK_SPACE_SZ             0x001C
39 #define DICE_EAP_NEW_ROUTING_SPACE_OFF     0x0020
40 #define DICE_EAP_NEW_ROUTING_SPACE_SZ      0x0024
41 #define DICE_EAP_NEW_STREAM_CFG_SPACE_OFF  0x0028
42 #define DICE_EAP_NEW_STREAM_CFG_SPACE_SZ   0x002C
43 #define DICE_EAP_CURR_CFG_SPACE_OFF        0x0030
44 #define DICE_EAP_CURR_CFG_SPACE_SZ         0x0034
45 #define DICE_EAP_STAND_ALONE_CFG_SPACE_OFF 0x0038
46 #define DICE_EAP_STAND_ALONE_CFG_SPACE_SZ  0x003C
47 #define DICE_EAP_APP_SPACE_OFF             0x0040
48 #define DICE_EAP_APP_SPACE_SZ              0x0044
49 #define DICE_EAP_ZERO_MARKER_1             0x0048
50
51 // CAPABILITY registers
52 #define DICE_EAP_CAPABILITY_ROUTER         0x0000
53 #define DICE_EAP_CAPABILITY_MIXER          0x0004
54 #define DICE_EAP_CAPABILITY_GENERAL        0x0008
55 #define DICE_EAP_CAPABILITY_RESERVED       0x000C
56
57 // CAPABILITY bit definitions
58 #define DICE_EAP_CAP_ROUTER_EXPOSED         0
59 #define DICE_EAP_CAP_ROUTER_READONLY        1
60 #define DICE_EAP_CAP_ROUTER_FLASHSTORED     2
61 #define DICE_EAP_CAP_ROUTER_MAXROUTES      16
62
63 #define DICE_EAP_CAP_MIXER_EXPOSED          0
64 #define DICE_EAP_CAP_MIXER_READONLY         1
65 #define DICE_EAP_CAP_MIXER_FLASHSTORED      2
66 #define DICE_EAP_CAP_MIXER_IN_DEV           4
67 #define DICE_EAP_CAP_MIXER_OUT_DEV          8
68 #define DICE_EAP_CAP_MIXER_INPUTS          16
69 #define DICE_EAP_CAP_MIXER_OUTPUTS         24
70
71 #define DICE_EAP_CAP_GENERAL_STRM_CFG_EN    0
72 #define DICE_EAP_CAP_GENERAL_FLASH_EN       1
73 #define DICE_EAP_CAP_GENERAL_PEAK_EN        2
74 #define DICE_EAP_CAP_GENERAL_MAX_TX_STREAM  4
75 #define DICE_EAP_CAP_GENERAL_MAX_RX_STREAM  8
76 #define DICE_EAP_CAP_GENERAL_STRM_CFG_FLS  12
77 #define DICE_EAP_CAP_GENERAL_CHIP          16
78
79 #define DICE_EAP_CAP_GENERAL_CHIP_DICEII    0
80 #define DICE_EAP_CAP_GENERAL_CHIP_DICEMINI  1
81 #define DICE_EAP_CAP_GENERAL_CHIP_DICEJR    2
82
83 // COMMAND registers
84 #define DICE_EAP_COMMAND_OPCODE         0x0000
85 #define DICE_EAP_COMMAND_RETVAL         0x0004
86
87 // opcodes
88 #define DICE_EAP_CMD_OPCODE_NO_OP            0x0000
89 #define DICE_EAP_CMD_OPCODE_LD_ROUTER        0x0001
90 #define DICE_EAP_CMD_OPCODE_LD_STRM_CFG      0x0002
91 #define DICE_EAP_CMD_OPCODE_LD_RTR_STRM_CFG  0x0003
92 #define DICE_EAP_CMD_OPCODE_LD_FLASH_CFG     0x0004
93 #define DICE_EAP_CMD_OPCODE_ST_FLASH_CFG     0x0005
94
95 #define DICE_EAP_CMD_OPCODE_FLAG_LD_LOW      (1U<<16)
96 #define DICE_EAP_CMD_OPCODE_FLAG_LD_MID      (1U<<17)
97 #define DICE_EAP_CMD_OPCODE_FLAG_LD_HIGH     (1U<<18)
98 #define DICE_EAP_CMD_OPCODE_FLAG_LD_EXECUTE  (1U<<31)
99
100
101 // MIXER registers
102 // TODO
103
104 // PEAK registers
105 // TODO
106
107 // NEW ROUTER registers
108 // TODO
109
110 // NEW STREAM CFG registers
111 // TODO
112
113 // CURRENT CFG registers
114 #define DICE_EAP_CURRCFG_LOW_ROUTER         0x0000
115 #define DICE_EAP_CURRCFG_LOW_STREAM         0x1000
116 #define DICE_EAP_CURRCFG_MID_ROUTER         0x2000
117 #define DICE_EAP_CURRCFG_MID_STREAM         0x3000
118 #define DICE_EAP_CURRCFG_HIGH_ROUTER        0x4000
119 #define DICE_EAP_CURRCFG_HIGH_STREAM        0x5000
120
121 #define DICE_EAP_CHANNEL_CONFIG_NAMESTR_LEN_QUADS  (64)
122 #define DICE_EAP_CHANNEL_CONFIG_NAMESTR_LEN_BYTES  (4*DICE_EAP_CHANNEL_CONFIG_NAMESTR_LEN_QUADS)
123
124 namespace Dice {
125
126 /**
127   @brief Sources for audio hitting the router
128   */
129 enum eRouteSource {
130     eRS_AES = 0,
131     eRS_ADAT = 1,
132     eRS_Mixer = 2,
133     eRS_InS0 = 4,
134     eRS_InS1 = 5,
135     eRS_ARM = 10,
136     eRS_ARX0 = 11,
137     eRS_ARX1 = 12,
138     eRS_Muted = 15,
139     eRS_Invalid = 16,
140 };
141 /**
142   @brief Destinations for audio exiting the router
143   */
144 enum eRouteDestination {
145     eRD_AES = 0,
146     eRD_ADAT = 1,
147     eRD_Mixer0 = 2,
148     eRD_Mixer1 = 3,
149     eRD_InS0 = 4,
150     eRD_InS1 = 5,
151     eRD_ARM = 10,
152     eRD_ATX0 = 11,
153     eRD_ATX1 = 12,
154     eRD_Muted = 15,
155     eRD_Invalid = 16,
156 };
157
158 /**
159   @brief represents the EAP interface available on some devices
160
161   When available, the mixer and router are visible. This class is also the base for custom
162   implementations of EAP extensions.
163   */
164 class EAP : public Control::Container
165 {
166 public:
167     /**
168       @brief Command status
169       */
170     enum eWaitReturn {
171         eWR_Error,
172         eWR_Timeout,
173         eWR_Busy,
174         eWR_Done,
175     };
176     /**
177       @brief Constants for the EAP spaces
178
179       @see offsetGen for the calculation of the real offsets.
180       */
181     enum eRegBase {
182         eRT_Base,
183         eRT_Capability,
184         eRT_Command,
185         eRT_Mixer,
186         eRT_Peak,
187         eRT_NewRouting,
188         eRT_NewStreamCfg,
189         eRT_CurrentCfg,
190         eRT_Standalone,
191         eRT_Application,
192         eRT_None,
193     };
194
195 private:
196
197     /**
198       @brief Description of the routing in the hardware
199       */
200     class RouterConfig {
201     private:
202         friend class Dice::EAP;
203         RouterConfig(EAP &);
204         RouterConfig(EAP &, enum eRegBase, unsigned int offset);
205         virtual ~RouterConfig();
206
207     public:
208
209         virtual bool read() {return read(m_base, m_offset);};
210         virtual bool write() {return write(m_base, m_offset);};
211         virtual bool read(enum eRegBase b, unsigned offset);
212         virtual bool write(enum eRegBase b, unsigned offset);
213         virtual void show();
214
215         /**
216           @brief map for the routes
217
218           The key is the destination as each destination can only have audio from one source.
219           Sources can be routed to several destinations though.
220           */
221         typedef std::map<unsigned char,unsigned char> RouteVectorV2;
222
223         /**
224           @brief Set up a route between src and dest
225
226           If a route with that destination exists, it will be replaced. If no route to that
227           destination exists, a new route will be established.
228           */
229         bool setupRoute(unsigned char src, unsigned char dest);
230         /**
231           @brief Remove a route
232
233           @todo is this really necessary?
234           */
235         bool removeRoute(unsigned char src, unsigned char dest);
236         /**
237           @brief Remove the destinations route
238           */
239         bool removeRoute(unsigned char dest);
240
241         /**
242           @brief Return the source for the given destination
243
244           Returns -1 if the destination is not connected.
245           */
246         unsigned char getSourceForDestination(unsigned char dest);
247         /**
248           @brief Return a list of destinations for a given source
249
250           Returns an empty list if no destination is connected to this source.
251           */
252         std::vector<unsigned char> getDestinationsForSource(unsigned char src);
253
254         unsigned int getNbRoutes() {return m_routes2.size();};
255
256     protected:
257         EAP &m_eap;
258         enum eRegBase m_base;
259         unsigned int m_offset;
260         RouteVectorV2 m_routes2;
261     protected:
262         DECLARE_DEBUG_MODULE_REFERENCE;
263     };
264
265     /**
266       the peak space is a special version of a router config
267       */
268     class PeakSpace : public RouterConfig {
269     private:
270         friend class Dice::EAP;
271         PeakSpace(EAP &p) : RouterConfig(p, eRT_Peak, 0) {};
272         virtual ~PeakSpace() {};
273
274     public:
275         virtual bool read() {return read(m_base, m_offset);};
276         virtual bool write() {return write(m_base, m_offset);};
277         virtual bool read(enum eRegBase b, unsigned offset);
278         virtual bool write(enum eRegBase b, unsigned offset);
279         virtual void show();
280     };
281
282     /**
283       @brief Description of the streams in the hardware
284       */
285     class StreamConfig {
286     private:
287         friend class Dice::EAP;
288         StreamConfig(EAP &, enum eRegBase, unsigned int offset);
289         ~StreamConfig();
290
291     public:
292         struct ConfigBlock { // FIXME: somewhere in the DICE avdevice this is present too
293             uint32_t nb_audio;
294             uint32_t nb_midi;
295             uint32_t names[DICE_EAP_CHANNEL_CONFIG_NAMESTR_LEN_QUADS];
296             uint32_t ac3_map;
297         };
298         void showConfigBlock(struct ConfigBlock &);
299         stringlist getNamesForBlock(struct ConfigBlock &b);
300
301         bool read() {return read(m_base, m_offset);};
302         bool write() {return write(m_base, m_offset);};
303         bool read(enum eRegBase b, unsigned offset);
304         bool write(enum eRegBase b, unsigned offset);
305
306         void show();
307
308     private:
309         EAP &m_eap;
310         enum eRegBase m_base;
311         unsigned int m_offset;
312
313         uint32_t m_nb_tx;
314         uint32_t m_nb_rx;
315
316         struct ConfigBlock *m_tx_configs;
317         struct ConfigBlock *m_rx_configs;
318
319         DECLARE_DEBUG_MODULE_REFERENCE;
320     };
321
322 public:
323
324     /**
325       @brief The matrixmixer exposed
326       */
327     class Mixer : public Control::MatrixMixer {
328     public:
329         Mixer(EAP &);
330         ~Mixer();
331
332         bool init();
333         void show();
334
335         void updateNameCache();
336         /**
337          * load the coefficients from the device into the local cache
338          * @return
339          */
340         bool loadCoefficients();
341         /**
342          * Stores the coefficients from the cache to the device
343          * @return
344          */
345         bool storeCoefficients();
346
347         virtual int getRowCount( );
348         virtual int getColCount( );
349
350         virtual int canWrite( const int, const int );
351         virtual double setValue( const int, const int, const double );
352         virtual double getValue( const int, const int );
353
354         // @TODO: re-implement names
355         bool hasNames() const { return false; }
356         //std::string getRowName( const int );
357         //std::string getColName( const int );
358
359         // TODO: implement connections.
360         bool canConnect() const { return false; }
361
362         // full map updates are unsupported
363         virtual bool getCoefficientMap(int &);
364         virtual bool storeCoefficientMap(int &);
365
366     private:
367         EAP &         m_eap;
368         fb_quadlet_t *m_coeff;
369
370         //std::map<int, RouterConfig::Route> m_input_route_map;
371         //std::map<int, RouterConfig::RouteVector> m_output_route_map;
372
373         DECLARE_DEBUG_MODULE_REFERENCE;
374     };
375
376     /**
377       @brief The router exposed
378       */
379     class Router : public Control::CrossbarRouter {
380     public:
381         Router(EAP &);
382         ~Router();
383
384         void show();
385
386         void addDestination(const std::string& name, enum eRouteDestination dstid,
387                             unsigned int base, unsigned int cnt, unsigned int offset=0);
388         void addSource(const std::string& name, enum eRouteSource srcid,
389                        unsigned int base, unsigned int cnt, unsigned int offset=0);
390
391         // per-coefficient access
392         virtual std::string getSourceName(const int);
393         virtual std::string getDestinationName(const int);
394         virtual int getSourceIndex(std::string);
395         virtual int getDestinationIndex(std::string);
396         virtual stringlist getSourceNames();
397         virtual stringlist getDestinationNames();
398
399         std::string getSourceForDestination(const std::string& dstname);
400         stringlist getDestinationsForSource(const std::string& srcname);
401
402         virtual bool canConnect(const int srcidx, const int dstidx);
403         virtual bool setConnectionState(const int srcidx, const int dstidx, const bool enable);
404         virtual bool getConnectionState(const int srcidx, const int dstidx);
405
406         virtual bool canConnect(const std::string& srcname, const std::string& dstname);
407         virtual bool setConnectionState(const std::string& srcname, const std::string& dstname, const bool enable);
408         virtual bool getConnectionState(const std::string& srcname, const std::string& dstname);
409
410         virtual bool clearAllConnections();
411
412         // peak metering support
413         virtual bool hasPeakMetering();
414         virtual double getPeakValue(const std::string& dest);
415         virtual std::map<std::string, double> getPeakValues();
416
417     private:
418         EAP &m_eap;
419         /**
420           @{
421           @brief Name-Index pairs for the sources and destinations
422
423           The index is 'artificial' and is the block/channel combination used in the dice.
424           */
425         std::map<std::string, int> m_sources;
426         std::map<std::string, int> m_destinations;
427         // @}
428
429         PeakSpace &m_peak;
430
431         DECLARE_DEBUG_MODULE_REFERENCE;
432     };
433
434 public:
435     /** constructor */
436     EAP(Device &);
437     /** destructor */
438     virtual ~EAP();
439
440     /**
441       @brief Does this device support the EAP?
442
443       When subclassing EAP, return true only on devices that actually have an EAP.
444
445       @todo Shouldn't this be inside Dice::Device?
446       */
447     static bool supportsEAP(Device &);
448
449     /**
450       @brief Initialize the EAP
451       */
452     bool init();
453
454     /// Show information about the EAP
455     void show();
456     /// Dump the first parts of the application space
457     void showApplication();
458
459     /// Restore from flash
460     bool loadFlashConfig();
461     /// Store to flash
462     bool storeFlashConfig();
463
464     /// Is the current operation still busy?
465     enum eWaitReturn operationBusy();
466     /// Block until the current operation is done
467     enum eWaitReturn waitForOperationEnd(int max_wait_time_ms = 100);
468
469     /// Update all configurations from the device
470     bool updateConfigurationCache();
471
472     /**
473       @{
474       @brief Read and write registers on the device
475       */
476     bool readReg(enum eRegBase, unsigned offset, quadlet_t *);
477     bool writeReg(enum eRegBase, unsigned offset, quadlet_t);
478     bool readRegBlock(enum eRegBase, unsigned, fb_quadlet_t *, size_t);
479     bool writeRegBlock(enum eRegBase, unsigned, fb_quadlet_t *, size_t);
480     bool readRegBlockSwapped(enum eRegBase, unsigned, fb_quadlet_t *, size_t);
481     bool writeRegBlockSwapped(enum eRegBase, unsigned, fb_quadlet_t *, size_t);
482     //@}
483
484     /** @brief Get access to the mixer */
485     Mixer*  getMixer() {return m_mixer;};
486     /** @brief Get access to the router */
487     Router* getRouter() {return m_router;};
488
489 protected:
490     /**
491       @brief Setup all the available sources
492
493       This adds the needed entries for sources to the router. The default implementation decides on
494       the chip which sources to add, subclasses should only add the sources actually usable for the
495       device.
496
497       To ease custom device support, this function is not in EAP::Router but here.
498       */
499     virtual void setupSources();
500     /**
501       @brief Setup all the available destinations
502
503       This adds the needed entries for destinations to the router. The default implementation
504       decides on the chip which destinations to add, subclasses should only add the destinations
505       actually usable for the device.
506
507       To ease custom device support, this function is not in EAP::Router but here.
508       */
509     virtual void setupDestinations();
510
511     /**
512       @brief Actually add the source
513       */
514     void addSource(const std::string name, unsigned int base, unsigned int count,
515                    enum eRouteSource srcid, unsigned int offset=0);
516     /**
517       @brief Actually add the destination
518       */
519     void addDestination(const std::string name, unsigned int base, unsigned int count,
520                         enum eRouteDestination destid, unsigned int offset=0);
521
522 private:
523     /// Return the router configuration for the current rate
524     RouterConfig * getActiveRouterConfig();
525     /// Return the stream configuration for the current rate
526     StreamConfig * getActiveStreamConfig();
527
528     /// Write a new router configuration to the device
529     bool updateRouterConfig(RouterConfig&, bool low, bool mid, bool high);
530     /// Write a new router configuration to the device
531     bool updateCurrentRouterConfig(RouterConfig&);
532     /// Write a new stream configuration to the device
533     bool updateStreamConfig(StreamConfig&, bool low, bool mid, bool high);
534     /// Write a new stream configuration to the device
535     bool updateStreamConfig(RouterConfig&, StreamConfig&, bool low, bool mid, bool high);
536
537     bool loadRouterConfig(bool low, bool mid, bool high);
538     bool loadStreamConfig(bool low, bool mid, bool high);
539     bool loadRouterAndStreamConfig(bool low, bool mid, bool high);
540
541 private:
542     bool     m_router_exposed;
543     bool     m_router_readonly;
544     bool     m_router_flashstored;
545     uint16_t m_router_nb_entries;
546
547     bool     m_mixer_exposed;
548     bool     m_mixer_readonly;
549     bool     m_mixer_flashstored;
550     uint8_t  m_mixer_tx_id;
551     uint8_t  m_mixer_rx_id;
552     uint8_t  m_mixer_nb_tx;
553     uint8_t  m_mixer_nb_rx;
554
555     bool     m_general_support_dynstream;
556     bool     m_general_support_flash;
557     bool     m_general_peak_enabled;
558     uint8_t  m_general_max_tx;
559     uint8_t  m_general_max_rx;
560     bool     m_general_stream_cfg_stored;
561     uint16_t m_general_chip;
562
563     bool commandHelper(fb_quadlet_t cmd);
564
565     /// Calculate the real offset for the different spaces
566     fb_nodeaddr_t offsetGen(enum eRegBase, unsigned, size_t);
567
568 private:
569     Device & m_device;
570     Mixer*   m_mixer;
571     Router*  m_router;
572     RouterConfig m_current_cfg_routing_low;
573     RouterConfig m_current_cfg_routing_mid;
574     RouterConfig m_current_cfg_routing_high;
575     StreamConfig m_current_cfg_stream_low;
576     StreamConfig m_current_cfg_stream_mid;
577     StreamConfig m_current_cfg_stream_high;
578
579     fb_quadlet_t m_capability_offset;
580     fb_quadlet_t m_capability_size;
581     fb_quadlet_t m_cmd_offset;
582     fb_quadlet_t m_cmd_size;
583     fb_quadlet_t m_mixer_offset;
584     fb_quadlet_t m_mixer_size;
585     fb_quadlet_t m_peak_offset;
586     fb_quadlet_t m_peak_size;
587     fb_quadlet_t m_new_routing_offset;
588     fb_quadlet_t m_new_routing_size;
589     fb_quadlet_t m_new_stream_cfg_offset;
590     fb_quadlet_t m_new_stream_cfg_size;
591     fb_quadlet_t m_curr_cfg_offset;
592     fb_quadlet_t m_curr_cfg_size;
593     fb_quadlet_t m_standalone_offset;
594     fb_quadlet_t m_standalone_size;
595     fb_quadlet_t m_app_offset;
596     fb_quadlet_t m_app_size;
597
598 protected:
599     DECLARE_DEBUG_MODULE;
600 };
601
602 };
603
604 #endif // __DICE_EAP_H
Note: See TracBrowser for help on using the browser.