source: trunk/kernel/devices/dev_txt.c @ 422

Last change on this file since 422 was 422, checked in by alain, 4 years ago

cosmetic

File size: 6.6 KB
Line 
1/*
2 * dev_txt.c - TXT (Text Terminal) generic device API implementation.
3 *
4 * Author  Alain Greiner    (2016)
5 *
6 * Copyright (c) UPMC Sorbonne Universites
7 *
8 * This file is part of ALMOS-MK
9 *
10 * ALMOS-MKH.is free software; you can redistribute it and/or modify it
11 * under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; version 2.0 of the License.
13 *
14 * ALMOS-MKH.is distributed in the hope that it will be useful, but
15 * WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
17 * General Public License for more details.
18 *
19 * You should have received a copy of the GNU General Public License
20 * along with ALMOS-kernel; if not, write to the Free Software Foundation,
21 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
22 */
23
24#include <hal_types.h>
25#include <hal_special.h>
26#include <hal_remote.h>
27#include <hal_drivers.h>
28#include <thread.h>
29#include <chdev.h>
30#include <rpc.h>
31#include <printk.h>
32#include <dev_txt.h>
33
34/////////////////////////////////////////////////////////////////////////////////////////
35// Extern global variables
36/////////////////////////////////////////////////////////////////////////////////////////
37
38extern chdev_directory_t  chdev_dir;         // allocated in kernel_init.c
39
40#if CONFIG_READ_DEBUG
41extern uint32_t enter_txt_read;
42extern uint32_t exit_txt_read;
43#endif
44
45//////////////////////////////////
46void dev_txt_init( chdev_t * txt )
47{
48    // For all TXT channels other than the TXT0 (kernel terminal),
49    // the PIC chdev must be initialized before the TXT chdev, because
50    // the TXT chdev initialization requires the routing of an external IRQ
51
52    xptr_t    pic_xp  = chdev_dir.pic;
53    uint32_t  channel = txt->channel;
54    uint32_t  impl    = txt->impl;
55    bool_t    is_rx   = txt->is_rx;
56
57    assert( (pic_xp != XPTR_NULL) || (channel == 0) , __FUNCTION__ , 
58            "PIC not initialised before TXT" );
59
60    // set chdev name
61    if( is_rx ) snprintf( txt->name , 16 , "txt%d_rx" , channel );
62    else        snprintf( txt->name , 16 , "txt%d_tx" , channel );
63
64    // set TXT chdev extension
65    txt->ext.txt.owner_xp = XPTR_NULL;
66    xlist_root_init( XPTR( local_cxy, &txt->ext.txt.root ) );
67    remote_spinlock_init( XPTR( local_cxy , &txt->ext.txt.lock ) );
68   
69    // call driver init function
70    hal_drivers_txt_init(txt, impl);
71
72    // no server thread and no IRQ routing for TXT0
73    // no server thread for IMPL_TXT_RS2 (multiplexed in software, not hardware)
74    if( channel != 0 && impl != IMPL_TXT_RS2 )
75    {
76        // select a core to execute the server thread
77        lid_t lid = cluster_select_local_core();
78
79        // bind IRQ to the selected core
80        dev_pic_bind_irq( lid , txt );
81
82        // enable IRQ
83        dev_pic_enable_irq( lid , XPTR( local_cxy , txt ) );
84
85        // create server thread
86        thread_t * new_thread;
87        error_t    error;
88
89        error = thread_kernel_create( &new_thread,
90                                      THREAD_DEV,
91                                      &chdev_sequencial_server,
92                                      txt,
93                                      lid );
94
95        assert( (error == 0) , __FUNCTION__ , "cannot create server thread" );
96
97        // set "server" field in chdev descriptor
98        txt->server = new_thread;
99
100        // set "chdev" field in thread descriptor
101        new_thread->chdev = txt;
102
103        // unblock server thread
104        thread_unblock( XPTR( local_cxy , new_thread ) , THREAD_BLOCKED_GLOBAL );
105    }
106}
107
108//////////////////////////////////////////////////////////////////////////////////
109// This static function is called by dev_txt_read(), dev_txt_write() functions.
110////////////////////////////////////i/////////////////////////////////////////////
111static error_t dev_txt_access( uint32_t   type,
112                               uint32_t   channel,
113                               char     * buffer,
114                               uint32_t   count )
115{
116    xptr_t     dev_xp;
117    thread_t * this = CURRENT_THREAD;
118
119txt_dmsg("\n[DBG] %s : core[%x,%d] (thread %s) enters / cycle %d\n",
120__FUNCTION__, local_cxy, this->core->lid, thread_type_str(this->type), hal_time_stamp() );
121
122    // check channel argument
123    assert( (channel < CONFIG_MAX_TXT_CHANNELS) , __FUNCTION__ , "illegal channel index" );
124
125    // get extended pointer on remote TXT chdev descriptor
126    if( type == TXT_WRITE )  dev_xp = chdev_dir.txt_tx[channel];
127    else                     dev_xp = chdev_dir.txt_rx[channel];
128
129    assert( (dev_xp != XPTR_NULL) , __FUNCTION__ , "undefined TXT chdev descriptor" );
130
131    // register command in calling thread descriptor
132    this->txt_cmd.dev_xp  = dev_xp;
133    this->txt_cmd.type    = type;
134    this->txt_cmd.buf_xp  = XPTR( local_cxy , buffer );
135    this->txt_cmd.count   = count;
136
137    // register client thread in waiting queue, activate server thread
138    // block client thread on THREAD_BLOCKED_IO and deschedule.
139    // it is re-activated by the ISR signaling IO operation completion.
140    chdev_register_command( dev_xp );
141
142txt_dmsg("\n[DBG] %s : core[%x,%d] (thread %s) exit / cycle %d\n",
143__FUNCTION__, local_cxy, this->core->lid, thread_type_str(this->type), hal_time_stamp() );
144
145    // return I/O operation status from calling thread descriptor
146    return this->txt_cmd.error;
147}
148
149/////////////////////////////////////////
150error_t dev_txt_write( uint32_t   channel,
151                       char     * buffer,
152                       uint32_t   count )
153{
154    error_t error = dev_txt_access( TXT_WRITE , channel , buffer , count );
155    return error;
156}
157
158/////////////////////////////////////////
159error_t dev_txt_read( uint32_t   channel,
160                      char     * buffer )
161{
162
163#if CONFIG_READ_DEBUG
164enter_txt_read = hal_time_stamp();
165#endif
166
167    error_t error = dev_txt_access( TXT_READ , channel , buffer , 1 );
168
169#if CONFIG_READ_DEBUG
170exit_txt_read = hal_time_stamp();
171#endif
172
173    return error;
174
175}
176
177//////////////////////////////////////////////
178error_t dev_txt_sync_write( char     * buffer,
179                            uint32_t   count )
180{
181    // get extended pointer on TXT[0] chdev
182    xptr_t  dev_xp = chdev_dir.txt_tx[0];
183
184    assert( (dev_xp != XPTR_NULL) , __FUNCTION__ ,
185    "undefined TXT0 chdev descriptor" );
186
187    // get TXTO chdev cluster and local pointer
188    cxy_t    dev_cxy  = GET_CXY( dev_xp );
189    chdev_t * dev_ptr = (chdev_t *)GET_PTR( dev_xp );
190
191    // get driver command function
192    dev_aux_t * aux = (dev_aux_t *)hal_remote_lpt( XPTR( dev_cxy , &dev_ptr->aux ) );
193
194    // build arguments structure
195    txt_aux_t  args;
196    args.dev_xp = dev_xp;
197    args.buffer = buffer;
198    args.count  = count;
199
200    // call driver function
201    aux( &args );
202
203    return 0;
204}
205
Note: See TracBrowser for help on using the repository browser.