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

Revision 2095, 19.5 kB (checked in by adi, 11 years ago)

DICE-EAP Use vector of pair rather than map for router config

By Philippe Carriere:

router config (m_routes2) is the image of what is really written in the flash.
The meaning of the router and peak space flash content is entirely
manufacturer dependent.

Then even the ordering followed by the destinations may be of importance
so it must be a priori preserved.

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         ~RouterConfig();
206
207     public:
208
209         bool read() {return read(m_base, m_offset);};
210         bool write() {return write(m_base, m_offset);};
211         bool read(enum eRegBase b, unsigned offset);
212         bool write(enum eRegBase b, unsigned offset);
213         void show();
214
215         /**
216           @brief Set up a route between src and dest
217
218           If a route with that destination exists, it will be replaced. If no route to that
219           destination exists, a new route will be established.
220           */
221         bool setupRoute(unsigned char src, unsigned char dest);
222         /**
223           @brief Remove a route
224
225           @todo is this really necessary?
226           */
227         bool removeRoute(unsigned char src, unsigned char dest);
228         /**
229           @brief Remove the destinations route
230           */
231         bool removeRoute(unsigned char dest);
232
233         /**
234           @brief Return the source for the given destination
235
236           Returns -1 if the destination is not connected.
237           */
238         unsigned char getSourceForDestination(unsigned char dest);
239         /**
240           @brief Return a list of destinations for a given source
241
242           Returns an empty list if no destination is connected to this source.
243           */
244         std::vector<unsigned char> getDestinationsForSource(unsigned char src);
245
246         unsigned int getNbRoutes() {return m_routes2.size();};
247
248     private:
249         EAP &m_eap;
250         enum eRegBase m_base;
251         unsigned int m_offset;
252
253         /**
254           @brief map for the routes
255
256           The key is the destination as each destination can only have audio from one source.
257           Sources can be routed to several destinations though.
258           */
259 //        typedef std::map<unsigned char,unsigned char> RouteVectorV2;
260         typedef std::vector< std::pair<unsigned char,unsigned char> > RouteVectorV2;
261         RouteVectorV2 m_routes2;
262     private:
263         DECLARE_DEBUG_MODULE_REFERENCE;
264     };
265
266     /**
267       @brief Description of the peak space in hardware
268       */
269     class PeakSpace {
270     private:
271         friend class Dice::EAP;
272         PeakSpace(EAP &p) : m_eap(p), m_base(eRT_Peak), m_offset(0), m_debugModule(p.m_debugModule) {};
273         ~PeakSpace() {};
274
275     public:
276         bool read() {return read(m_base, m_offset);};
277         bool read(enum eRegBase b, unsigned offset);
278         void show();
279
280         std::map<unsigned char, int> getPeaks();
281         int getPeak(unsigned char dest);
282
283     private:
284         EAP &m_eap;
285         enum eRegBase m_base;
286         unsigned int m_offset;
287
288         /**
289           @brief maps peaks to destinations
290           */
291         std::map<unsigned char, int> m_peaks;
292
293         DECLARE_DEBUG_MODULE_REFERENCE;
294     };
295
296     /**
297       @brief Description of the streams in the hardware
298       */
299     class StreamConfig {
300     private:
301         friend class Dice::EAP;
302         StreamConfig(EAP &, enum eRegBase, unsigned int offset);
303         ~StreamConfig();
304
305     public:
306         struct ConfigBlock { // FIXME: somewhere in the DICE avdevice this is present too
307             uint32_t nb_audio;
308             uint32_t nb_midi;
309             uint32_t names[DICE_EAP_CHANNEL_CONFIG_NAMESTR_LEN_QUADS];
310             uint32_t ac3_map;
311         };
312         void showConfigBlock(struct ConfigBlock &);
313         stringlist getNamesForBlock(struct ConfigBlock &b);
314         stringlist getTxNamesString(unsigned int);
315         stringlist getRxNamesString(unsigned int);
316
317         bool read() {return read(m_base, m_offset);};
318         bool write() {return write(m_base, m_offset);};
319         bool read(enum eRegBase b, unsigned offset);
320         bool write(enum eRegBase b, unsigned offset);
321
322         void show();
323
324     private:
325         EAP &m_eap;
326         enum eRegBase m_base;
327         unsigned int m_offset;
328
329         uint32_t m_nb_tx;
330         uint32_t m_nb_rx;
331
332         struct ConfigBlock *m_tx_configs;
333         struct ConfigBlock *m_rx_configs;
334
335         DECLARE_DEBUG_MODULE_REFERENCE;
336     };
337
338 public:
339
340     /**
341       @brief The matrixmixer exposed
342       */
343     class Mixer : public Control::MatrixMixer {
344     public:
345         Mixer(EAP &);
346         ~Mixer();
347
348         bool init();
349         void show();
350
351         void updateNameCache();
352         /**
353          * load the coefficients from the device into the local cache
354          * @return
355          */
356         bool loadCoefficients();
357         /**
358          * Stores the coefficients from the cache to the device
359          * @return
360          */
361         bool storeCoefficients();
362
363         virtual int getRowCount( );
364         virtual int getColCount( );
365
366         virtual int canWrite( const int, const int );
367         virtual double setValue( const int, const int, const double );
368         virtual double getValue( const int, const int );
369
370         //
371         bool hasNames() const { return false; }
372         std::string getRowName( const int );
373         std::string getColName( const int );
374
375         // TODO: implement connections.
376         bool canConnect() const { return false; }
377
378         // full map updates are unsupported
379         virtual bool getCoefficientMap(int &);
380         virtual bool storeCoefficientMap(int &);
381
382     private:
383         EAP &         m_eap;
384         fb_quadlet_t *m_coeff;
385
386         //std::map<int, RouterConfig::Route> m_input_route_map;
387         //std::map<int, RouterConfig::RouteVector> m_output_route_map;
388
389         DECLARE_DEBUG_MODULE_REFERENCE;
390     };
391
392     /**
393       @brief The router exposed
394       */
395     class Router : public Control::CrossbarRouter {
396     public:
397         Router(EAP &);
398         ~Router();
399
400         void update();
401         void show();
402
403         void addDestination(const std::string& name, enum eRouteDestination dstid,
404                             unsigned int base, unsigned int cnt, unsigned int offset=0);
405         void addSource(const std::string& name, enum eRouteSource srcid,
406                        unsigned int base, unsigned int cnt, unsigned int offset=0);
407
408         // per-coefficient access
409         virtual std::string getSourceName(const int);
410         virtual std::string getDestinationName(const int);
411         virtual int getSourceIndex(std::string);
412         virtual int getDestinationIndex(std::string);
413         virtual stringlist getSourceNames();
414         virtual stringlist getDestinationNames();
415
416         std::string getSourceForDestination(const std::string& dstname);
417         stringlist getDestinationsForSource(const std::string& srcname);
418
419         virtual bool canConnect(const int srcidx, const int dstidx);
420         virtual bool setConnectionState(const int srcidx, const int dstidx, const bool enable);
421         virtual bool getConnectionState(const int srcidx, const int dstidx);
422
423         virtual bool canConnect(const std::string& srcname, const std::string& dstname);
424         virtual bool setConnectionState(const std::string& srcname, const std::string& dstname, const bool enable);
425         virtual bool getConnectionState(const std::string& srcname, const std::string& dstname);
426
427         virtual bool clearAllConnections();
428
429         // peak metering support
430         virtual bool hasPeakMetering();
431         virtual double getPeakValue(const std::string& dest);
432         virtual std::map<std::string, double> getPeakValues();
433
434     private:
435         EAP &m_eap;
436         /**
437           @{
438           @brief Name-Index pairs for the sources and destinations
439
440           The index is 'artificial' and is the block/channel combination used in the dice.
441           */
442         std::map<std::string, int> m_sources;
443         std::map<std::string, int> m_destinations;
444         // @}
445
446         PeakSpace &m_peak;
447
448         DECLARE_DEBUG_MODULE_REFERENCE;
449     };
450
451 public:
452     /** constructor */
453     EAP(Device &);
454     /** destructor */
455     virtual ~EAP();
456
457     /**
458       @brief Does this device support the EAP?
459
460       When subclassing EAP, return true only on devices that actually have an EAP.
461
462       @todo Shouldn't this be inside Dice::Device?
463       */
464     static bool supportsEAP(Device &);
465
466     /**
467       @brief Initialize the EAP
468       */
469     bool init();
470
471     /// update EAP
472     void update();
473
474     /// Show information about the EAP
475     void show();
476     /// Dump the first parts of the application space
477     void showApplication();
478     /// Show the full router content
479     void showFullRouter();
480     /// Show the full peak space content
481     void showFullPeakSpace();
482
483     /// Restore from flash
484     bool loadFlashConfig();
485     /// Store to flash
486     bool storeFlashConfig();
487
488     /// Is the current operation still busy?
489     enum eWaitReturn operationBusy();
490     /// Block until the current operation is done
491     enum eWaitReturn waitForOperationEnd(int max_wait_time_ms = 100);
492
493     /// Update all configurations from the device
494     bool updateConfigurationCache();
495
496     /**
497       @{
498       @brief Read and write registers on the device
499       */
500     bool readReg(enum eRegBase, unsigned offset, quadlet_t *);
501     bool writeReg(enum eRegBase, unsigned offset, quadlet_t);
502     bool readRegBlock(enum eRegBase, unsigned, fb_quadlet_t *, size_t);
503     bool writeRegBlock(enum eRegBase, unsigned, fb_quadlet_t *, size_t);
504     bool readRegBlockSwapped(enum eRegBase, unsigned, fb_quadlet_t *, size_t);
505     bool writeRegBlockSwapped(enum eRegBase, unsigned, fb_quadlet_t *, size_t);
506     //@}
507
508     /** @brief Get access to the mixer */
509     Mixer*  getMixer() {return m_mixer;};
510     /** @brief Get access to the router */
511     Router* getRouter() {return m_router;};
512
513     /** @brief Get capture and playback names */
514     stringlist getCptrNameString(unsigned int);
515     stringlist getPbckNameString(unsigned int);
516
517 protected:
518     /**
519       @brief Setup all the available sources
520
521       This adds the needed entries for sources to the router. The default implementation decides on
522       the chip which sources to add, subclasses should only add the sources actually usable for the
523       device.
524
525       To ease custom device support, this function is not in EAP::Router but here.
526       */
527     void setupSources();
528     virtual void setupSources_low();
529     virtual void setupSources_mid();
530     virtual void setupSources_high();
531     /**
532       @brief Setup all the available destinations
533
534       This adds the needed entries for destinations to the router. The default implementation
535       decides on the chip which destinations to add, subclasses should only add the destinations
536       actually usable for the device.
537
538       To ease custom device support, this function is not in EAP::Router but here.
539       */
540     void setupDestinations();
541     virtual void setupDestinations_low();
542     virtual void setupDestinations_mid();
543     virtual void setupDestinations_high();
544
545     /**
546       @brief Actually add the source
547       */
548     void addSource(const std::string name, unsigned int base, unsigned int count,
549                    enum eRouteSource srcid, unsigned int offset=0);
550     /**
551       @brief Actually add the destination
552       */
553     void addDestination(const std::string name, unsigned int base, unsigned int count,
554                         enum eRouteDestination destid, unsigned int offset=0);
555
556     uint16_t getMaxNbRouterEntries() {return m_router_nb_entries;};
557
558 private:
559     /// Return the router configuration for the current rate
560     RouterConfig * getActiveRouterConfig();
561     /// Return the stream configuration for the current rate
562     StreamConfig * getActiveStreamConfig();
563
564     /// Write a new router configuration to the device
565     bool updateRouterConfig(RouterConfig&, bool low, bool mid, bool high);
566     /// Write a new router configuration to the device
567     bool updateCurrentRouterConfig(RouterConfig&);
568     /// Write a new stream configuration to the device
569     bool updateStreamConfig(StreamConfig&, bool low, bool mid, bool high);
570     /// Write a new stream configuration to the device
571     bool updateStreamConfig(RouterConfig&, StreamConfig&, bool low, bool mid, bool high);
572
573     bool loadRouterConfig(bool low, bool mid, bool high);
574     bool loadStreamConfig(bool low, bool mid, bool high);
575     bool loadRouterAndStreamConfig(bool low, bool mid, bool high);
576
577 private:
578     bool     m_router_exposed;
579     bool     m_router_readonly;
580     bool     m_router_flashstored;
581     uint16_t m_router_nb_entries;
582
583     bool     m_mixer_exposed;
584     bool     m_mixer_readonly;
585     bool     m_mixer_flashstored;
586     uint8_t  m_mixer_tx_id;
587     uint8_t  m_mixer_rx_id;
588     uint8_t  m_mixer_nb_tx;
589     uint8_t  m_mixer_nb_rx;
590
591     bool     m_general_support_dynstream;
592     bool     m_general_support_flash;
593     bool     m_general_peak_enabled;
594     uint8_t  m_general_max_tx;
595     uint8_t  m_general_max_rx;
596     bool     m_general_stream_cfg_stored;
597     uint16_t m_general_chip;
598
599     bool commandHelper(fb_quadlet_t cmd);
600
601     /// Calculate the real offset for the different spaces
602     fb_nodeaddr_t offsetGen(enum eRegBase, unsigned, size_t);
603
604 private:
605     Device & m_device;
606     Mixer*   m_mixer;
607     Router*  m_router;
608     RouterConfig m_current_cfg_routing_low;
609     RouterConfig m_current_cfg_routing_mid;
610     RouterConfig m_current_cfg_routing_high;
611     StreamConfig m_current_cfg_stream_low;
612     StreamConfig m_current_cfg_stream_mid;
613     StreamConfig m_current_cfg_stream_high;
614
615     fb_quadlet_t m_capability_offset;
616     fb_quadlet_t m_capability_size;
617     fb_quadlet_t m_cmd_offset;
618     fb_quadlet_t m_cmd_size;
619     fb_quadlet_t m_mixer_offset;
620     fb_quadlet_t m_mixer_size;
621     fb_quadlet_t m_peak_offset;
622     fb_quadlet_t m_peak_size;
623     fb_quadlet_t m_new_routing_offset;
624     fb_quadlet_t m_new_routing_size;
625     fb_quadlet_t m_new_stream_cfg_offset;
626     fb_quadlet_t m_new_stream_cfg_size;
627     fb_quadlet_t m_curr_cfg_offset;
628     fb_quadlet_t m_curr_cfg_size;
629     fb_quadlet_t m_standalone_offset;
630     fb_quadlet_t m_standalone_size;
631     fb_quadlet_t m_app_offset;
632     fb_quadlet_t m_app_size;
633
634 protected:
635     DECLARE_DEBUG_MODULE;
636 };
637
638 };
639
640 #endif // __DICE_EAP_H
Note: See TracBrowser for help on using the browser.