Previous 15994 Revisions Next

r6175 Friday 23rd October, 2009 at 09:25:23 UTC by Miodrag Milanović
Removed XMODEM implementation from serial, was not used, and it should be implemented inside machine software not a MESS code
[docs]messnew.txt
[src/mess/drivers]abc80x.c atarist.c bw2.c newbrain.c
[src/mess/machine]nc.c serial.c serial.h thomson.c

src/mess/machine/serial.c
r6174r6175
4343/* the serial streams */
4444static struct serial_device   serial_devices[MAX_SERIAL_DEVICES];
4545static TIMER_CALLBACK(serial_device_baud_rate_callback);
46static void xmodem_init(void);
4746
4847
4948/*********************************************************/
r6174r6175
8685   serial_devices[id].connection.input_state = status;
8786}
8887
89/*********************************************************/
90
91static void serial_protocol_none_sent_char(int id);
92
93static const struct serial_protocol_interface serial_protocol_none_interface=
94{
95   NULL,
96   serial_protocol_none_sent_char,
97};
98
99
100static void serial_protocol_xmodem_receive_char(int id, unsigned char ch);
101static void serial_protocol_xmodem_sent_char(int id);
102
103static const struct serial_protocol_interface serial_protocol_xmodem_interface=
104{
105   serial_protocol_xmodem_receive_char,
106   serial_protocol_xmodem_sent_char
107};
108
109
110/**********************************************************/
111
11288/***** SERIAL DEVICE ******/
11389void serial_device_setup(const device_config *image, int baud_rate, int num_data_bits, int stop_bit_count, int parity_code)
11490{
r6174r6175
138114   serial_connection_out(image->machine,&serial_devices[id].connection);
139115   transmit_register_reset(&serial_devices[id].transmit_reg);
140116   receive_register_reset(&serial_devices[id].receive_reg);
141   receive_register_setup(&serial_devices[id].receive_reg, &serial_devices[id].data_form);
142   memset(&serial_devices[id].protocol_interface, 0, sizeof(struct serial_protocol_interface));
143   /* temp here */
144   xmodem_init();
117   receive_register_setup(&serial_devices[id].receive_reg, &serial_devices[id].data_form);   
145118}
146119
147120
r6174r6175
152125   return serial_devices[id].connection.State;
153126}
154127
155
156static const char *const protocol_names[]=
157{
158   "None",
159   "XModem"
160};
161
162/* get name of current protocol */
163const char *serial_device_get_protocol_name(int protocol_id)
164{
165   return protocol_names[protocol_id];
166}
167
168void serial_device_set_protocol(const device_config *image, int protocol_id)
169{
170   int id = image_index_in_device(image);
171
172   if ((id<0) || (id>=MAX_SERIAL_DEVICES))
173      return;
174
175   serial_devices[id].protocol = protocol_id;
176
177   switch (serial_devices[id].protocol)
178   {
179      default:
180      case SERIAL_PROTOCOL_NONE:
181      {
182         memcpy(&serial_devices[id].protocol_interface,&serial_protocol_none_interface,sizeof(struct serial_protocol_interface));
183
184      }
185      break;
186
187      case SERIAL_PROTOCOL_XMODEM:
188      {
189         memcpy(&serial_devices[id].protocol_interface,&serial_protocol_xmodem_interface,sizeof(struct serial_protocol_interface));
190      }
191      break;
192   }
193}
194
195128void serial_device_set_transmit_state(const device_config *image, int state)
196129{
197130   int previous_state;
r6174r6175
256189   return data_bit;
257190}
258191
259static int data_stream_get_byte(struct data_stream *stream)
260{
261   int data_byte;
262192
263   if (stream->ByteCount>=stream->DataLength)
264   {
265      return 0;
266   }
267
268   data_byte = stream->pData[stream->ByteCount];
269   stream->ByteCount++;
270
271   return data_byte;
272}
273
274193void   receive_register_setup(struct serial_receive_register *receive, struct data_form *data_form)
275194{
276195   receive->bit_count = data_form->word_length + data_form->stop_bit_count;
r6174r6175
541460      receive_register_extract(&serial_devices[id].receive_reg, &serial_devices[id].data_form);
542461
543462      logerror("serial device receive char: %02x\n",serial_devices[id].receive_reg.byte_received);
544
545      /* if callback setup, execute it */
546      if (serial_devices[id].protocol_interface.character_received_callback)
547         serial_devices[id].protocol_interface.character_received_callback(id, serial_devices[id].receive_reg.byte_received);
548463   }
549464
550465   /* is transmit empty? */
551466   if (serial_devices[id].transmit_reg.flags & TRANSMIT_REGISTER_EMPTY)
552467   {
553468      /* char has been sent, execute callback */
554      if (serial_devices[id].protocol_interface.character_sent_callback)
555         serial_devices[id].protocol_interface.character_sent_callback(id);
469      serial_protocol_none_sent_char(id);
556470   }
557471
558472   /* other side says it is clear to send? */
r6174r6175
673587   data_stream_free(&serial_devices[id].receive);
674588}
675589
676/********************************************************************************************************/
677/***** XMODEM protocol ****/
678
679static void serial_update_crc(unsigned short *crc, unsigned char value)
680{
681   UINT8 l, h;
682
683   l = value ^ (*crc >> 8);
684   *crc = (*crc & 0xff) | (l << 8);
685   l >>= 4;
686   l ^= (*crc >> 8);
687   *crc <<= 8;
688   *crc = (*crc & 0xff00) | l;
689   l = (l << 4) | (l >> 4);
690   h = l;
691   l = (l << 2) | (l >> 6);
692   l &= 0x1f;
693   *crc = *crc ^ (l << 8);
694   l = h & 0xf0;
695   *crc = *crc ^ (l << 8);
696   l = (h << 1) | (h >> 7);
697   l &= 0xe0;
698   *crc = *crc ^ l;
699}
700
701/* XMODEM protocol */
702enum
703{
704   XMODEM_STATE_WAITING_FOR_LINK,
705   XMODEM_STATE_SENDING_PACKET,
706   XMODEM_STATE_WAITING_FOR_CONFIRM,
707   XMODEM_WAITING_FOR_END_CONFIRM1,
708   XMODEM_WAITING_FOR_END_CONFIRM2
709};
710
711
712struct xmodem
713{
714   int state;
715   int packet_id;
716   unsigned char packet[1024];
717   unsigned long offset_in_packet;
718   unsigned long packet_size;
719};
720
721static struct xmodem xmodem_transfer;
722
723static void xmodem_set_new_state(int);
724
725void   xmodem_init(void)
726{
727   xmodem_set_new_state(XMODEM_STATE_WAITING_FOR_LINK);
728   xmodem_transfer.packet_id = 1;
729}
730
731static void xmodem_setup_packet(int id)
732{
733   int i;
734   int count;
735   UINT16 crc;
736
737   count = 0;
738
739
740   /*
741    packet:
742
743    1 byte          SOH
744    1 byte          packet id
745    1 byte          packet id (stored 1's complemented)
746    128 bytes       data
747    1 byte          CRC-16 upper byte
748    1 byte          CRC-16 lower byte
749    */
750
751   /* soh */
752   xmodem_transfer.packet[count] = XMODEM_SOH;
753   count++;
754   /* packet id */
755   xmodem_transfer.packet[count] = xmodem_transfer.packet_id & 0x0ff;
756   count++;
757   /* 1's complement of packet id */
758   xmodem_transfer.packet[count] = (xmodem_transfer.packet_id^0x0ff) & 0x0ff;
759   count++;
760
761   crc = 0;
762
763   for (i=0; i<128; i++)
764   {
765      xmodem_transfer.packet[count] = data_stream_get_byte(&serial_devices[id].transmit);
766      serial_update_crc(&crc, xmodem_transfer.packet[count]);
767      count++;
768   }
769
770   xmodem_transfer.packet[count] = (crc>>8) & 0x0ff;
771   count++;
772   xmodem_transfer.packet[count] = crc & 0x0ff;
773   count++;
774
775   xmodem_transfer.packet_size = count;
776   xmodem_transfer.offset_in_packet = 0;
777
778}
779
780static void xmodem_resend_block(void)
781{
782   xmodem_transfer.offset_in_packet = 0;
783   xmodem_set_new_state(XMODEM_STATE_SENDING_PACKET);
784}
785
786
787static void xmodem_set_new_state(int state)
788{
789   xmodem_transfer.state = state;
790}
791
792static void serial_protocol_xmodem_receive_char(int id, unsigned char ch)
793{
794   switch (xmodem_transfer.state)
795   {
796      case XMODEM_STATE_WAITING_FOR_LINK:
797      {
798         if (ch==XMODEM_CRC_NAK)
799         {
800            logerror("xmodem nak received\n");
801
802            xmodem_setup_packet(id);
803            xmodem_set_new_state(XMODEM_STATE_SENDING_PACKET);
804         }
805      }
806      break;
807
808      case XMODEM_STATE_WAITING_FOR_CONFIRM:
809      {
810         switch (ch)
811         {
812            case XMODEM_ACK:
813            {
814               logerror("block accepted\n");
815               xmodem_transfer.packet_id++;
816               xmodem_setup_packet(id);
817               xmodem_set_new_state(XMODEM_STATE_SENDING_PACKET);
818            }
819            break;
820
821            case XMODEM_NAK:
822            {
823               logerror("resend block\n");
824               xmodem_resend_block();
825            }
826            break;
827
828            default:
829            {
830               logerror("unknown response\n");
831            }
832            break;
833         }
834      }
835      break;
836
837      default:
838         break;
839   }
840}
841
842static void serial_protocol_xmodem_sent_char(int id)
843{
844   switch (xmodem_transfer.state)
845   {
846      case XMODEM_STATE_SENDING_PACKET:
847      {
848         unsigned char data_byte;
849
850         if (xmodem_transfer.offset_in_packet==xmodem_transfer.packet_size)
851         {
852            xmodem_set_new_state(XMODEM_STATE_WAITING_FOR_CONFIRM);
853            return;
854         }
855
856         /* generate byte to transmit */
857         data_byte = xmodem_transfer.packet[xmodem_transfer.offset_in_packet];
858         xmodem_transfer.offset_in_packet++;
859         logerror("packet byte: %02x\n",data_byte);
860
861         /* setup register */
862         transmit_register_setup(&serial_devices[id].transmit_reg,&serial_devices[id].data_form, data_byte);
863
864         logerror("serial device transmitted char: %02x\n",data_byte);
865      }
866      break;
867
868
869
870      default:
871         break;
872   }
873}
874
875590/*******************************************************************************/
591/*******************************************************************************/
876592/********* SERIAL CONNECTION ***********/
877593
878594
src/mess/machine/serial.h
r6174r6175
7575/* TX = Transmit data. (OUTPUT) */
7676#define SERIAL_STATE_TX_DATA   0x00020
7777
78/* protocol selections */
79
80/* all data is transmitted with a start bit, data bits, optional parity bit,
81and stop bits. These are programmable. */
82enum
83{
84   SERIAL_PROTOCOL_NONE,      /* no protocol applied */
85   SERIAL_PROTOCOL_XMODEM      /* transfer data using xmodem protocol */
86};
87
8878/* parity selections */
8979/* if all the bits are added in a byte, if the result is:
9080    even -> parity is even
r6174r6175
251241   unsigned long ByteCount;
252242};
253243
254/* an internal interface used by serial device */
255struct serial_protocol_interface
256{
257   /* callback executed when character has been received */
258   void (*character_received_callback)(int id,unsigned char ch);
259   /* callback executed when character has been transmitted, ready to transmit a new char */
260   void (*character_sent_callback)(int id);
261};
262
263244/* a serial device */
264245struct serial_device
265246{
r6174r6175
280261   struct data_form data_form;
281262
282263   int transmit_state;
283   int protocol;
284264
285265   /* baud rate */
286266   unsigned long BaudRate;
287267
288268   /* baud rate timer */
289269   void   *timer;
290
291   struct serial_protocol_interface protocol_interface;
292270};
293271
294272unsigned long serial_device_get_state(int id);
r6174r6175
305283
306284void serial_device_setup(const device_config *image, int baud_rate, int num_data_bits, int stop_bit_count, int parity_code);
307285
308/* get name of protocol identified by specified id */
309const char *serial_device_get_protocol_name(int protocol_id);
310
311/* set the protocol to be used by the serial device */
312void serial_device_set_protocol(const device_config *image, int protocol_id);
313286/* set the transmit state of the serial device */
314287void serial_device_set_transmit_state(const device_config *image, int state);
315288
316/***********************************************************************************************/
317/* XModem protocol */
318
319#define XMODEM_CRC_NAK   67 /* begins a xmodem-crc transfer */
320#define XMODEM_SOH      1   /* id of a 256 byte block */
321#define XMODEM_EOT      4
322#define XMODEM_ACK      6
323#define XMODEM_NAK      21   /* begins a xmodem transfer */
324#define XMODEM_CAN      24
325#define XMODEM_STX      2   /* id start of a 1k block */
326
327
328289#endif /* SERIAL_H_ */
src/mess/machine/thomson.c
r6174r6175
406406   }
407407
408408   serial_device_setup( device, 2400, 7, 2, SERIAL_PARITY_NONE ); /* default */
409   serial_device_set_protocol( device, SERIAL_PROTOCOL_NONE );
410409   serial_device_set_transmit_state( device, 1 );
411410}
412411
src/mess/machine/nc.c
r6174r6175
156156      /* connect serial chip to serial device */
157157      msm8251_connect_to_serial_device(uart, image);
158158
159      serial_device_set_protocol(image, SERIAL_PROTOCOL_NONE);
160
161159      /* and start transmit */
162160      serial_device_set_transmit_state(image,1);
163161
src/mess/drivers/atarist.c
r6174r6175
21522152      /* setup transmit parameters */
21532153      serial_device_setup(image, 9600, 8, 1, SERIAL_PARITY_NONE);
21542154
2155      serial_device_set_protocol(image, SERIAL_PROTOCOL_NONE);
2156
21572155      /* and start transmit */
21582156      serial_device_set_transmit_state(image, 1);
21592157
src/mess/drivers/abc80x.c
r6174r6175
14771477      /* setup transmit parameters */
14781478      serial_device_setup(image, 9600 >> input_port_read(image->machine, "BAUD"), 8, 1, SERIAL_PARITY_NONE);
14791479
1480      serial_device_set_protocol(image, SERIAL_PROTOCOL_NONE);
1481
14821480      /* and start transmit */
14831481      serial_device_set_transmit_state(image, 1);
14841482
src/mess/drivers/newbrain.c
r6174r6175
16691669      /* setup transmit parameters */
16701670      serial_device_setup(image, 9600, 8, 1, SERIAL_PARITY_NONE);
16711671
1672      serial_device_set_protocol(image, SERIAL_PROTOCOL_NONE);
1673
16741672      /* and start transmit */
16751673      serial_device_set_transmit_state(image, 1);
16761674
src/mess/drivers/bw2.c
r6174r6175
247247      /* connect serial chip to serial device */
248248      msm8251_connect_to_serial_device(state->msm8251, image);
249249
250      serial_device_set_protocol(image, SERIAL_PROTOCOL_NONE);
251
252250      /* and start transmit */
253251      serial_device_set_transmit_state(image, 1);
254252
docs/messnew.txt
r6174r6175
265265
266266- Converted all drivers to use messram device.  [Miodrag Milanovic]
267267
268- Removed XMODEM implementation from serial, was not used, and it should be
269  implemented inside machine software not a MESS code [Miodrag Milanovic]
268270
269271
270
2712720.134
272273
273274New System Drivers Supported (in no particular order):

Previous 15994 Revisions Next


© 1998-2018 The MESS Team