/* * Copyright 2012-2013 Luke Dashjr * Copyright 2012 Con Kolivas * * This program is free software; you can redistribute it and/or modify it * under the terms of the GNU General Public License as published by the Free * Software Foundation; either version 3 of the License, or (at your option) * any later version. See COPYING for more details. */ #include "config.h" #include #include #include #include #include #include #include #include "compat.h" #include "deviceapi.h" #include "miner.h" #include "fpgautils.h" #define BITFORCE_SLEEP_MS 500 #define BITFORCE_TIMEOUT_S 7 #define BITFORCE_TIMEOUT_MS (BITFORCE_TIMEOUT_S * 1000) #define BITFORCE_LONG_TIMEOUT_S 25 #define BITFORCE_LONG_TIMEOUT_MS (BITFORCE_LONG_TIMEOUT_S * 1000) #define BITFORCE_CHECK_INTERVAL_MS 10 #define WORK_CHECK_INTERVAL_MS 50 #define MAX_START_DELAY_MS 100 #define tv_to_ms(tval) ((unsigned long)(tval.tv_sec * 1000 + tval.tv_usec / 1000)) #define TIME_AVG_CONSTANT 8 #define KNAME_WORK "full work" #define KNAME_RANGE "nonce range" struct device_api bitforce_api; // Code must deal with a timeout #define BFopen(devpath) serial_open(devpath, 0, 250, true) static void BFgets(char *buf, size_t bufLen, int fd) { do { buf[0] = '\0'; --bufLen; } while (likely(bufLen && read(fd, buf, 1) == 1 && (buf++)[0] != '\n')); buf[0] = '\0'; } static ssize_t BFwrite(int fd, const void *buf, ssize_t bufLen) { if ((bufLen) != write(fd, buf, bufLen)) return 0; else return bufLen; } #define BFclose(fd) close(fd) static bool bitforce_detect_one(const char *devpath) { int fdDev = serial_open(devpath, 0, 10, true); struct cgpu_info *bitforce; char pdevbuf[0x100]; char *s; applog(LOG_DEBUG, "BFL: Attempting to open %s", devpath); if (unlikely(fdDev == -1)) { applog(LOG_DEBUG, "BFL: Failed to open %s", devpath); return false; } BFwrite(fdDev, "ZGX", 3); pdevbuf[0] = '\0'; BFgets(pdevbuf, sizeof(pdevbuf), fdDev); if (unlikely(!pdevbuf[0])) { applog(LOG_DEBUG, "BFL: Error reading/timeout (ZGX)"); return 0; } BFclose(fdDev); if (unlikely(!strstr(pdevbuf, "SHA256"))) { applog(LOG_DEBUG, "BFL: Didn't recognise BitForce on %s", devpath); return false; } // We have a real BitForce! bitforce = calloc(1, sizeof(*bitforce)); bitforce->api = &bitforce_api; bitforce->device_path = strdup(devpath); bitforce->deven = DEV_ENABLED; bitforce->threads = 1; if (likely((!memcmp(pdevbuf, ">>>ID: ", 7)) && (s = strstr(pdevbuf + 3, ">>>")))) { s[0] = '\0'; bitforce->name = strdup(pdevbuf + 7); } mutex_init(&bitforce->device_mutex); return add_cgpu(bitforce); } static int bitforce_detect_auto(void) { return serial_autodetect(bitforce_detect_one, "BitFORCE", "SHA256"); } static void bitforce_detect(void) { serial_detect_auto(&bitforce_api, bitforce_detect_one, bitforce_detect_auto); } struct bitforce_data { unsigned char next_work_ob[70]; char noncebuf[0x100]; int poll_func; }; static void bitforce_clear_buffer(struct cgpu_info *); static void bitforce_comm_error(struct thr_info *thr) { struct cgpu_info *bitforce = thr->cgpu; struct bitforce_data *data = bitforce->cgpu_data; data->noncebuf[0] = '\0'; applog(LOG_ERR, "%"PRIpreprv": Comms error", bitforce->proc_repr); dev_error(bitforce, REASON_DEV_COMMS_ERROR); ++bitforce->hw_errors; ++hw_errors; BFclose(bitforce->device_fd); int fd = bitforce->device_fd = BFopen(bitforce->device_path); if (fd == -1) { applog(LOG_ERR, "%"PRIpreprv": Error reopening", bitforce->proc_repr); return; } /* empty read buffer */ bitforce_clear_buffer(bitforce); } static void get_bitforce_statline_before(char *buf, struct cgpu_info *bitforce) { float gt = bitforce->temp; if (gt > 0) tailsprintf(buf, "%5.1fC ", gt); else tailsprintf(buf, " ", gt); tailsprintf(buf, " | "); } static bool bitforce_thread_prepare(struct thr_info *thr) { struct cgpu_info *bitforce = thr->cgpu; int fdDev = BFopen(bitforce->device_path); struct timeval now; if (unlikely(fdDev == -1)) { applog(LOG_ERR, "%"PRIpreprv": Failed to open %s", bitforce->proc_repr, bitforce->device_path); return false; } bitforce->device_fd = fdDev; applog(LOG_INFO, "%"PRIpreprv": Opened %s", bitforce->proc_repr, bitforce->device_path); gettimeofday(&now, NULL); get_datestamp(bitforce->init, &now); return true; } static void bitforce_clear_buffer(struct cgpu_info *bitforce) { int fdDev = bitforce->device_fd; char pdevbuf[0x100]; int count = 0; if (!fdDev) return; applog(LOG_DEBUG, "%"PRIpreprv": Clearing read buffer", bitforce->proc_repr); mutex_lock(&bitforce->device_mutex); do { pdevbuf[0] = '\0'; BFgets(pdevbuf, sizeof(pdevbuf), fdDev); } while (pdevbuf[0] && (++count < 10)); mutex_unlock(&bitforce->device_mutex); } void bitforce_init(struct cgpu_info *bitforce) { const char *devpath = bitforce->device_path; int fdDev = bitforce->device_fd, retries = 0; char pdevbuf[0x100]; char *s; applog(LOG_WARNING, "%"PRIpreprv": Re-initialising", bitforce->proc_repr); bitforce_clear_buffer(bitforce); mutex_lock(&bitforce->device_mutex); if (fdDev) { BFclose(fdDev); sleep(5); } bitforce->device_fd = 0; fdDev = BFopen(devpath); if (unlikely(fdDev == -1)) { mutex_unlock(&bitforce->device_mutex); applog(LOG_ERR, "%"PRIpreprv": Failed to open %s", bitforce->proc_repr, devpath); return; } do { BFwrite(fdDev, "ZGX", 3); pdevbuf[0] = '\0'; BFgets(pdevbuf, sizeof(pdevbuf), fdDev); if (unlikely(!pdevbuf[0])) { mutex_unlock(&bitforce->device_mutex); applog(LOG_ERR, "%"PRIpreprv": Error reading/timeout (ZGX)", bitforce->proc_repr); return; } if (retries++) nmsleep(10); } while (!strstr(pdevbuf, "BUSY") && (retries * 10 < BITFORCE_TIMEOUT_MS)); if (unlikely(!strstr(pdevbuf, "SHA256"))) { mutex_unlock(&bitforce->device_mutex); applog(LOG_ERR, "%"PRIpreprv": Didn't recognise BitForce on %s returned: %s", bitforce->proc_repr, devpath, pdevbuf); return; } if (likely((!memcmp(pdevbuf, ">>>ID: ", 7)) && (s = strstr(pdevbuf + 3, ">>>")))) { s[0] = '\0'; bitforce->name = strdup(pdevbuf + 7); } bitforce->device_fd = fdDev; bitforce->sleep_ms = BITFORCE_SLEEP_MS; mutex_unlock(&bitforce->device_mutex); } static void bitforce_flash_led(struct cgpu_info *bitforce) { int fdDev = bitforce->device_fd; if (!fdDev) return; /* Do not try to flash the led if we're polling for a result to * minimise the chance of interleaved results */ if (bitforce->polling) return; /* It is not critical flashing the led so don't get stuck if we * can't grab the mutex here */ if (mutex_trylock(&bitforce->device_mutex)) return; BFwrite(fdDev, "ZMX", 3); /* Once we've tried - don't do it until told to again */ bitforce->flash_led = false; /* However, this stops anything else getting a reply * So best to delay any other access to the BFL */ sleep(4); mutex_unlock(&bitforce->device_mutex); return; // nothing is returned by the BFL } static bool bitforce_get_temp(struct cgpu_info *bitforce) { int fdDev = bitforce->device_fd; char pdevbuf[0x100]; char *s; if (!fdDev) return false; /* Do not try to get the temperature if we're polling for a result to * minimise the chance of interleaved results */ if (bitforce->polling) return true; // Flash instead of Temp - doing both can be too slow if (bitforce->flash_led) { bitforce_flash_led(bitforce); return true; } /* It is not critical getting temperature so don't get stuck if we * can't grab the mutex here */ if (mutex_trylock(&bitforce->device_mutex)) return false; BFwrite(fdDev, "ZLX", 3); pdevbuf[0] = '\0'; BFgets(pdevbuf, sizeof(pdevbuf), fdDev); mutex_unlock(&bitforce->device_mutex); if (unlikely(!pdevbuf[0])) { applog(LOG_ERR, "%"PRIpreprv": Error: Get temp returned empty string/timed out", bitforce->proc_repr); bitforce->hw_errors++; ++hw_errors; return false; } if ((!strncasecmp(pdevbuf, "TEMP", 4)) && (s = strchr(pdevbuf + 4, ':'))) { float temp = strtof(s + 1, NULL); /* Cope with older software that breaks and reads nonsense * values */ if (temp > 100) temp = strtod(s + 1, NULL); if (temp > 0) { bitforce->temp = temp; } } else { /* Use the temperature monitor as a kind of watchdog for when * our responses are out of sync and flush the buffer to * hopefully recover */ applog(LOG_WARNING, "%"PRIpreprv": Garbled response probably throttling, clearing buffer", bitforce->proc_repr); dev_error(bitforce, REASON_DEV_THROTTLE); /* Count throttling episodes as hardware errors */ bitforce->hw_errors++; ++hw_errors; bitforce_clear_buffer(bitforce); return false; } return true; } static bool bitforce_job_prepare(struct thr_info *thr, struct work *work, __maybe_unused uint64_t max_nonce) { struct cgpu_info *bitforce = thr->cgpu; struct bitforce_data *data = bitforce->cgpu_data; unsigned char *ob_ms = &data->next_work_ob[8]; unsigned char *ob_dt = &ob_ms[32]; // If polling job_start, cancel it if (data->poll_func == 1) { thr->tv_poll.tv_sec = -1; data->poll_func = 0; } memcpy(ob_ms, work->midstate, 32); memcpy(ob_dt, work->data + 64, 12); if (bitforce->nonce_range) { uint32_t *ob_nonce = (uint32_t*)&(ob_dt[32]); ob_nonce[0] = htobe32(work->blk.nonce); ob_nonce[1] = htobe32(work->blk.nonce + bitforce->nonces); // FIXME: if nonce range fails... we didn't increment enough work->blk.nonce += bitforce->nonces + 1; } else work->blk.nonce = 0xffffffff; return true; } static void bitforce_change_mode(struct cgpu_info *bitforce, bool noncerange) { struct bitforce_data *data = bitforce->cgpu_data; if (bitforce->nonce_range == noncerange) return; bitforce->nonce_range = noncerange; if (noncerange) { /* Split work up into 1/5th nonce ranges */ bitforce->nonces = 0x33333332; bitforce->sleep_ms /= 5; bitforce->kname = KNAME_RANGE; } else { bitforce->nonces = 0xffffffff; bitforce->sleep_ms *= 5; bitforce->kname = KNAME_WORK; memset(&data->next_work_ob[8+32+12], '>', 8); } } static void bitforce_job_start(struct thr_info *thr) { struct cgpu_info *bitforce = thr->cgpu; struct bitforce_data *data = bitforce->cgpu_data; int fdDev = bitforce->device_fd; unsigned char *ob = data->next_work_ob; char pdevbuf[0x100]; char *s; struct timeval tv_now; if (!fdDev) goto commerr; re_send: mutex_lock(&bitforce->device_mutex); if (bitforce->nonce_range) BFwrite(fdDev, "ZPX", 3); else BFwrite(fdDev, "ZDX", 3); pdevbuf[0] = '\0'; BFgets(pdevbuf, sizeof(pdevbuf), fdDev); if (!pdevbuf[0] || !strncasecmp(pdevbuf, "B", 1)) { mutex_unlock(&bitforce->device_mutex); gettimeofday(&tv_now, NULL); timer_set_delay(&thr->tv_poll, &tv_now, WORK_CHECK_INTERVAL_MS * 1000); data->poll_func = 1; return; } else if (unlikely(strncasecmp(pdevbuf, "OK", 2))) { mutex_unlock(&bitforce->device_mutex); if (bitforce->nonce_range) { applog(LOG_WARNING, "%"PRIpreprv": Does not support nonce range, disabling", bitforce->proc_repr); bitforce_change_mode(bitforce, false); goto re_send; } applog(LOG_ERR, "%"PRIpreprv": Error: Send work reports: %s", bitforce->proc_repr, pdevbuf); goto commerr; } if (!bitforce->nonce_range) { BFwrite(fdDev, ob, 60); } else { BFwrite(fdDev, ob, 68); } pdevbuf[0] = '\0'; BFgets(pdevbuf, sizeof(pdevbuf), fdDev); mt_job_transition(thr); mutex_unlock(&bitforce->device_mutex); if (opt_debug) { s = bin2hex(ob + 8, 44); applog(LOG_DEBUG, "%"PRIpreprv": block data: %s", bitforce->proc_repr, s); free(s); } if (unlikely(!pdevbuf[0])) { applog(LOG_ERR, "%"PRIpreprv": Error: Send block data returned empty string/timed out", bitforce->proc_repr); goto commerr; } if (unlikely(strncasecmp(pdevbuf, "OK", 2))) { applog(LOG_ERR, "%"PRIpreprv": Error: Send block data reports: %s", bitforce->proc_repr, pdevbuf); goto commerr; } gettimeofday(&tv_now, NULL); bitforce->work_start_tv = tv_now; timer_set_delay(&thr->tv_morework, &tv_now, bitforce->sleep_ms * 1000); job_start_complete(thr); return; commerr: bitforce_comm_error(thr); job_start_abort(thr, true); } static inline int noisy_stale_wait(unsigned int mstime, struct work*work, bool checkend, struct cgpu_info*bitforce) { int rv = stale_wait(mstime, work, checkend); if (rv) applog(LOG_NOTICE, "%"PRIpreprv": Abandoning stale search to restart", bitforce->proc_repr); return rv; } #define noisy_stale_wait(mstime, work, checkend) noisy_stale_wait(mstime, work, checkend, bitforce) static void bitforce_job_get_results(struct thr_info *thr, struct work *work) { struct cgpu_info *bitforce = thr->cgpu; struct bitforce_data *data = bitforce->cgpu_data; int fdDev = bitforce->device_fd; unsigned int delay_time_ms; struct timeval elapsed; struct timeval now; char *pdevbuf = &data->noncebuf[0]; bool stale; gettimeofday(&now, NULL); timersub(&now, &bitforce->work_start_tv, &elapsed); bitforce->wait_ms = tv_to_ms(elapsed); bitforce->polling = true; if (!fdDev) goto commerr; stale = stale_work(work, true); if (unlikely(bitforce->wait_ms < bitforce->sleep_ms)) { // We're likely here because of a work restart // Since Bitforce cannot stop a work without losing results, only do it if the current job is finding stale shares if (!stale) { delay_time_ms = bitforce->sleep_ms - bitforce->wait_ms; timer_set_delay(&thr->tv_poll, &now, delay_time_ms * 1000); data->poll_func = 2; return; } } while (1) { mutex_lock(&bitforce->device_mutex); BFwrite(fdDev, "ZFX", 3); pdevbuf[0] = '\0'; BFgets(pdevbuf, sizeof(data->noncebuf), fdDev); mutex_unlock(&bitforce->device_mutex); gettimeofday(&now, NULL); timersub(&now, &bitforce->work_start_tv, &elapsed); if (elapsed.tv_sec >= BITFORCE_LONG_TIMEOUT_S) { applog(LOG_ERR, "%"PRIpreprv": took %lums - longer than %lums", bitforce->proc_repr, tv_to_ms(elapsed), (unsigned long)BITFORCE_LONG_TIMEOUT_MS); goto out; } if (pdevbuf[0] && strncasecmp(pdevbuf, "B", 1)) /* BFL does not respond during throttling */ break; if (stale) { applog(LOG_NOTICE, "%"PRIpreprv": Abandoning stale search to restart", bitforce->proc_repr); goto out; } /* if BFL is throttling, no point checking so quickly */ delay_time_ms = (pdevbuf[0] ? BITFORCE_CHECK_INTERVAL_MS : 2 * WORK_CHECK_INTERVAL_MS); timer_set_delay(&thr->tv_poll, &now, delay_time_ms * 1000); data->poll_func = 2; return; } if (elapsed.tv_sec > BITFORCE_TIMEOUT_S) { applog(LOG_ERR, "%"PRIpreprv": took %lums - longer than %lums", bitforce->proc_repr, tv_to_ms(elapsed), (unsigned long)BITFORCE_TIMEOUT_MS); dev_error(bitforce, REASON_DEV_OVER_HEAT); ++bitforce->hw_errors; ++hw_errors; /* If the device truly throttled, it didn't process the job and there * are no results. But check first, just in case we're wrong about it * throttling. */ if (strncasecmp(pdevbuf, "NONCE-FOUND", 11)) goto out; } else if (!strncasecmp(pdevbuf, "N", 1)) {/* Hashing complete (NONCE-FOUND or NO-NONCE) */ /* Simple timing adjustment. Allow a few polls to cope with * OS timer delays being variably reliable. wait_ms will * always equal sleep_ms when we've waited greater than or * equal to the result return time.*/ delay_time_ms = bitforce->sleep_ms; if (bitforce->wait_ms > bitforce->sleep_ms + (WORK_CHECK_INTERVAL_MS * 2)) bitforce->sleep_ms += (bitforce->wait_ms - bitforce->sleep_ms) / 2; else if (bitforce->wait_ms == bitforce->sleep_ms) { if (bitforce->sleep_ms > WORK_CHECK_INTERVAL_MS) bitforce->sleep_ms -= WORK_CHECK_INTERVAL_MS; else if (bitforce->sleep_ms > BITFORCE_CHECK_INTERVAL_MS) bitforce->sleep_ms -= BITFORCE_CHECK_INTERVAL_MS; } if (delay_time_ms != bitforce->sleep_ms) applog(LOG_DEBUG, "%"PRIpreprv": Wait time changed to: %d, waited %u", bitforce->proc_repr, bitforce->sleep_ms, bitforce->wait_ms); /* Work out the average time taken. Float for calculation, uint for display */ bitforce->avg_wait_f += (tv_to_ms(elapsed) - bitforce->avg_wait_f) / TIME_AVG_CONSTANT; bitforce->avg_wait_d = (unsigned int) (bitforce->avg_wait_f + 0.5); } applog(LOG_DEBUG, "%"PRIpreprv": waited %dms until %s", bitforce->proc_repr, bitforce->wait_ms, pdevbuf); if (strncasecmp(pdevbuf, "NONCE-FOUND", 11) && (pdevbuf[2] != '-') && strncasecmp(pdevbuf, "I", 1)) { bitforce->hw_errors++; ++hw_errors; applog(LOG_WARNING, "%"PRIpreprv": Error: Get result reports: %s", bitforce->proc_repr, pdevbuf); bitforce_clear_buffer(bitforce); } out: bitforce->polling = false; job_results_fetched(thr); return; commerr: bitforce_comm_error(thr); goto out; } static int64_t bitforce_job_process_results(struct thr_info *thr, struct work *work, __maybe_unused bool stopping) { struct cgpu_info *bitforce = thr->cgpu; struct bitforce_data *data = bitforce->cgpu_data; char *pnoncebuf = &data->noncebuf[0]; uint32_t nonce; if (!strncasecmp(pnoncebuf, "NO-", 3)) return bitforce->nonces; /* No valid nonce found */ if (strncasecmp(pnoncebuf, "NONCE-FOUND", 11)) return 0; pnoncebuf += 12; while (1) { hex2bin((void*)&nonce, pnoncebuf, 4); nonce = be32toh(nonce); if (unlikely(bitforce->nonce_range && (nonce >= work->blk.nonce || /* FIXME: blk.nonce is probably moved on quite a bit now! */ (work->blk.nonce > 0 && nonce < work->blk.nonce - bitforce->nonces - 1)))) { applog(LOG_WARNING, "%"PRIpreprv": Disabling broken nonce range support", bitforce->proc_repr); bitforce_change_mode(bitforce, false); } submit_nonce(thr, work, nonce); if (strncmp(&pnoncebuf[8], ",", 1)) break; pnoncebuf += 9; } // FIXME: This might have changed in the meantime (new job start, or broken) return bitforce->nonces; } static void bitforce_shutdown(struct thr_info *thr) { struct cgpu_info *bitforce = thr->cgpu; BFclose(bitforce->device_fd); bitforce->device_fd = 0; } static void biforce_thread_enable(struct thr_info *thr) { struct cgpu_info *bitforce = thr->cgpu; bitforce_init(bitforce); } static bool bitforce_get_stats(struct cgpu_info *bitforce) { return bitforce_get_temp(bitforce); } static bool bitforce_identify(struct cgpu_info *bitforce) { bitforce->flash_led = true; return true; } static bool bitforce_thread_init(struct thr_info *thr) { struct cgpu_info *bitforce = thr->cgpu; unsigned int wait; struct bitforce_data *data; bitforce->cgpu_data = data = malloc(sizeof(*data)); *data = (struct bitforce_data){ .next_work_ob = ">>>>>>>>|---------- MidState ----------||-DataTail-|>>>>>>>>>>>>>>>>", }; bitforce->nonce_range = true; bitforce->sleep_ms = BITFORCE_SLEEP_MS; bitforce_change_mode(bitforce, false); /* Initially enable support for nonce range and disable it later if it * fails */ if (opt_bfl_noncerange) bitforce_change_mode(bitforce, true); /* Pause each new thread at least 100ms between initialising * so the devices aren't making calls all at the same time. */ wait = thr->id * MAX_START_DELAY_MS; applog(LOG_DEBUG, "%"PRIpreprv": Delaying start by %dms", bitforce->proc_repr, wait / 1000); nmsleep(wait); return true; } static struct api_data *bitforce_api_stats(struct cgpu_info *cgpu) { struct api_data *root = NULL; // Warning, access to these is not locked - but we don't really // care since hashing performance is way more important than // locking access to displaying API debug 'stats' // If locking becomes an issue for any of them, use copy_data=true also root = api_add_uint(root, "Sleep Time", &(cgpu->sleep_ms), false); root = api_add_uint(root, "Avg Wait", &(cgpu->avg_wait_d), false); return root; } void bitforce_poll(struct thr_info *thr) { struct cgpu_info *bitforce = thr->cgpu; struct bitforce_data *data = bitforce->cgpu_data; int poll = data->poll_func; thr->tv_poll.tv_sec = -1; data->poll_func = 0; switch (poll) { case 1: bitforce_job_start(thr); break; case 2: bitforce_job_get_results(thr, thr->work); break; default: applog(LOG_ERR, "%"PRIpreprv": Unexpected poll from device API!", thr->cgpu->proc_repr); } } struct device_api bitforce_api = { .dname = "bitforce", .name = "BFL", .api_detect = bitforce_detect, .get_api_stats = bitforce_api_stats, .minerloop = minerloop_async, .reinit_device = bitforce_init, .get_statline_before = get_bitforce_statline_before, .get_stats = bitforce_get_stats, .identify_device = bitforce_identify, .thread_prepare = bitforce_thread_prepare, .thread_init = bitforce_thread_init, .job_prepare = bitforce_job_prepare, .job_start = bitforce_job_start, .job_get_results = bitforce_job_get_results, .poll = bitforce_poll, .job_process_results = bitforce_job_process_results, .thread_shutdown = bitforce_shutdown, .thread_enable = biforce_thread_enable };